olb::DynamicsPromise< T, DESCRIPTOR > Class Template Reference

Factory for instances of a specific Dynamics type. More...

#include <blockDynamicsMap.h>

Collaboration diagram for olb::DynamicsPromise< T, DESCRIPTOR >:

Public Member Functions
template<typename DYNAMICS >
	DynamicsPromise (meta::id< DYNAMICS > id=meta::id< DYNAMICS >{})
std::type_index	id () const
	Returns type index of the promised DYNAMICS.
Dynamics< T, DESCRIPTOR > *	realize ()
	Returns new instance of the promised DYNAMICS.
template<Platform PLATFORM>
BlockCollisionO< T, DESCRIPTOR, PLATFORM > *	realize ()
	Returns new instance of the collision operator for promised DYNAMICS.

Protected Attributes
std::type_index	_id
std::function< Dynamics< T, DESCRIPTOR > *()>	_dynamicsConstructor
std::function< AbstractCollisionO< T, DESCRIPTOR > *(Platform)>	_operatorConstructor

Detailed Description

template<typename T, typename DESCRIPTOR>
class olb::DynamicsPromise< T, DESCRIPTOR >

Factory for instances of a specific Dynamics type.

Factory callables for DYNAMICS and ConcreteBlockCollisionO<DYNAMICS> are constructed at DynamicsPromise construction time. Recipients accepting such promised dynamics are not obligated to actually realize this promise.

This structure is needed to bridge the gap between high level virtual interfaces and efficient platform-specific implementations with full type knowledge. i.e. DynamicsPromise can carry full dynamics type information through the virtual layer surrounding concrete platform-specialized block lattices (needed as virtual template methods are not supported by C++).

Definition at line 278 of file blockDynamicsMap.h.

Constructor & Destructor Documentation

DynamicsPromise()

template<typename T , typename DESCRIPTOR >

template<typename DYNAMICS >

olb::DynamicsPromise< T, DESCRIPTOR >::DynamicsPromise ( meta::id< DYNAMICS > id = meta::id<DYNAMICS>{} )

inline

Definition at line 286 of file blockDynamicsMap.h.

                                                        {}):
    _id(typeid(DYNAMICS)),
    _dynamicsConstructor([]() -> Dynamics<T,DESCRIPTOR>* {
      return new DYNAMICS();
    }),
    _operatorConstructor([](Platform platform) -> AbstractCollisionO<T,DESCRIPTOR>* {
      static_assert(dynamics::is_generic_v<T,DESCRIPTOR,DYNAMICS>,
                    "Promised DYNAMICS must be generic");
      switch (platform) {
      #ifdef PLATFORM_CPU_SISD
      case Platform::CPU_SISD:
        return new ConcreteBlockCollisionO<T,DESCRIPTOR,Platform::CPU_SISD,DYNAMICS>();
      #endif
      #ifdef PLATFORM_CPU_SIMD
      case Platform::CPU_SIMD:
        return new ConcreteBlockCollisionO<T,DESCRIPTOR,Platform::CPU_SIMD,DYNAMICS>();
      #endif
      #ifdef PLATFORM_GPU_CUDA
      case Platform::GPU_CUDA:
        return new ConcreteBlockCollisionO<T,DESCRIPTOR,Platform::GPU_CUDA,DYNAMICS>();
      #endif
      default:
        throw std::invalid_argument("Invalid PLATFORM");
      }
    })
  { }

Member Function Documentation

id()

template<typename T , typename DESCRIPTOR >

std::type_index olb::DynamicsPromise< T, DESCRIPTOR >::id ( ) const

inline

Returns type index of the promised DYNAMICS.

Definition at line 314 of file blockDynamicsMap.h.

                           {
    return _id;
  }

References olb::DynamicsPromise< T, DESCRIPTOR >::_id.

realize() [1/2]

template<typename T , typename DESCRIPTOR >

Dynamics< T, DESCRIPTOR > * olb::DynamicsPromise< T, DESCRIPTOR >::realize ( )

inline

Returns new instance of the promised DYNAMICS.

Definition at line 319 of file blockDynamicsMap.h.

                                    {
    return _dynamicsConstructor();
  };

References olb::DynamicsPromise< T, DESCRIPTOR >::_dynamicsConstructor.

realize() [2/2]

template<typename T , typename DESCRIPTOR >

template<Platform PLATFORM>

BlockCollisionO< T, DESCRIPTOR, PLATFORM > * olb::DynamicsPromise< T, DESCRIPTOR >::realize ( )

inline

Returns new instance of the collision operator for promised DYNAMICS.

Definition at line 325 of file blockDynamicsMap.h.

                                                    {
    return static_cast<BlockCollisionO<T,DESCRIPTOR,PLATFORM>*>(
      _operatorConstructor(PLATFORM));
  };

References olb::DynamicsPromise< T, DESCRIPTOR >::_operatorConstructor.

Member Data Documentation

_dynamicsConstructor

template<typename T , typename DESCRIPTOR >

std::function<Dynamics<T,DESCRIPTOR>*()> olb::DynamicsPromise< T, DESCRIPTOR >::_dynamicsConstructor

protected

Definition at line 281 of file blockDynamicsMap.h.

_id

template<typename T , typename DESCRIPTOR >

std::type_index olb::DynamicsPromise< T, DESCRIPTOR >::_id

protected

Definition at line 280 of file blockDynamicsMap.h.

_operatorConstructor

template<typename T , typename DESCRIPTOR >

std::function<AbstractCollisionO<T,DESCRIPTOR>*(Platform)> olb::DynamicsPromise< T, DESCRIPTOR >::_operatorConstructor

protected

Definition at line 282 of file blockDynamicsMap.h.

---

The documentation for this class was generated from the following file:

• src/core/blockDynamicsMap.h