Homec4science
Diffusion tamaas (feature/mpi_fft_engine) Browse

tamaas/src/core/tamaas.hh
0670ef204b92feature/mpi_fft_engine

Last Change
Raw File

tamaas.hh
View Options

/**
* @mainpage Tamaas - A high-performance periodic contact library
*
* @section Introduction
* Tamaas is a spectral-integral-equation based contact library. It is made
* with love to be fast and friendly!
*
* @author Guillaume Anciaux <guillaume.anciaux@epfl.ch>
* @author Lucas Frérot <lucas.frerot@protonmail.com>
* @author Valentine Rey <valentine.rey@epfl.ch>
* @author Son Pham-Ba <son.phamba@epfl.ch>
*
* @section LICENSE
*
* Copyright (©) 2016-2020 EPFL (École Polytechnique Fédérale de Lausanne),
* Laboratory (LSMS - Laboratoire de Simulation en Mécanique des Solides)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
*/
/* -------------------------------------------------------------------------- */
#ifndef TAMAAS_HH
#define TAMAAS_HH
/* -------------------------------------------------------------------------- */
#define TAMAAS_BACKEND_OMP 1
#define TAMAAS_BACKEND_TBB 2
#define TAMAAS_BACKEND_CPP 3
#ifndef TAMAAS_BACKEND
#define TAMAAS_BACKEND TAMAAS_BACKEND_OMP
#endif
// If the thrust device hasn't been set, set OpenMP
#ifndef THRUST_DEVICE_SYSTEM
#define THRUST_DEVICE_SYSTEM THRUST_DEVICE_SYSTEM_OMP
#endif
/* -------------------------------------------------------------------------- */
// Standard includes
#include <exception>
#include <iostream>
#include <memory>
#include <string>
#include <type_traits>
/* -------------------------------------------------------------------------- */
// Special thrust includes
#include <thrust/complex.h>
#include <thrust/random.h>
#ifdef USE_CUDA
#include "unified_allocator.hh"
#endif
#include "fftw_allocator.hh"
/* -------------------------------------------------------------------------- */
namespace tamaas {
/* -------------------------------------------------------------------------- */
/// @section Cuda specific definitions
#define CUDA_LAMBDA __device__ __host__
#ifdef USE_CUDA
template <typename T>
using Allocator = UnifiedAllocator<T>;
#else
template <typename T>
using Allocator = FFTWAllocator<T>;
#endif
/// @section Common types definitions
// If type macros have not been set, put default values
#ifndef TAMAAS_REAL_TYPE
#define TAMAAS_REAL_TYPE double
#endif
#ifndef TAMAAS_INT_TYPE
#define TAMAAS_INT_TYPE int
#endif
using Real = TAMAAS_REAL_TYPE; ///< default floating point type
using Int = TAMAAS_INT_TYPE; ///< default signed integer type
using UInt = std::make_unsigned_t<Int>; ///< default unsigned integer type
template <typename T>
using complex = thrust::complex<T>; ///< template complex wrapper
using Complex = complex<Real>; ///< default floating point complex type
/// @section Defining random toolbox
using ::thrust::random::normal_distribution;
using ::thrust::random::uniform_real_distribution;
using random_engine = ::thrust::random::default_random_engine;
namespace detail {
template <bool acc, template <typename> class Trait, typename Head,
typename... Tail>
struct fold_trait_tail_rec
: std::integral_constant<bool,
fold_trait_tail_rec<acc and Trait<Head>::value,
Trait, Tail...>::value> {};
template <bool acc, template <typename> class Trait, typename Head>
struct fold_trait_tail_rec<acc, Trait, Head>
: std::integral_constant<bool, acc and Trait<Head>::value> {};
} // namespace detail
template <template <typename> class Trait, typename... T>
struct fold_trait : detail::fold_trait_tail_rec<true, Trait, T...> {};
/* -------------------------------------------------------------------------- */
/// initialize tamaas (0 threads => let OMP_NUM_THREADS decide)
void initialize(UInt num_threads = 0);
/// cleanup tamaas
void finalize();
/* -------------------------------------------------------------------------- */
/// Generic exception class
class Exception : public std::exception {
public:
/// Constructor
Exception(std::string mesg) : msg(std::move(mesg)) {}
const char* what() const noexcept override { return msg.c_str(); }
~Exception() override = default;
private:
std::string msg; ///< message of exception
};
/* -------------------------------------------------------------------------- */
/// Enumeration of reduction operations
enum class operation { plus, times, min, max };
/* -------------------------------------------------------------------------- */
} // namespace tamaas
/* -------------------------------------------------------------------------- */
/// @section Convenience macros
#define TAMAAS_DEBUG_MSG(mesg) \
__FILE__ << ':' << __LINE__ << ": " << mesg << '\n'
#define TAMAAS_EXCEPTION(mesg) \
{ \
std::stringstream sstr; \
sstr << TAMAAS_DEBUG_MSG("FATAL: " << mesg); \
throw ::tamaas::Exception(sstr.str()); \
}
#define SURFACE_FATAL(mesg) TAMAAS_EXCEPTION(mesg)
#if defined(TAMAAS_DEBUG)
#define TAMAAS_ASSERT(cond, reason) \
do { \
if (not(cond)) { \
TAMAAS_EXCEPTION(#cond " assert failed: " << reason); \
} \
} while (0)
#define TAMAAS_DEBUG_EXCEPTION(reason) TAMAAS_EXCEPTION(reason)
#else
#define TAMAAS_ASSERT(cond, reason)
#define TAMAAS_DEBUG_EXCEPTION(reason)
#endif
#define TAMAAS_ACCESSOR(var, type, name) \
type& get##name() { return var; } \
void set##name(const type& new_var) { var = new_var; }
/* -------------------------------------------------------------------------- */
#endif // TAMAAS_HH
c4science · Help