olb::AbstractCouplingO< COUPLEES > Struct Template Reference

Base of block-wide coupling operators executed by SuperLatticeCoupling. More...

#include <operator.h>

Inheritance diagram for olb::AbstractCouplingO< COUPLEES >:

Collaboration diagram for olb::AbstractCouplingO< COUPLEES >:

Public Types
using	value_t = typename COUPLEES::values_t::template get<0>::value_t
	Value type used for coupling parameters.
using	descriptor_t = typename COUPLEES::values_t::template get<0>::descriptor_t
	Descriptor type used for coupling parameters.
using	AbstractParameters = olb::AbstractParameters<value_t,descriptor_t>
using	ParametersD = olb::ParametersD<value_t,descriptor_t>
using	LatticeR = olb::LatticeR<descriptor_t::d>
template<typename FIELD >
using	FieldD = olb::FieldD<value_t,descriptor_t,FIELD>

Public Member Functions
virtual void	execute ()=0
	Execute coupling operation.
virtual AbstractParameters &	getParameters ()=0
	Return reference to parameters of coupling operator.
virtual void	set (CellID iCell, bool state)=0
	Set whether iCell is covered by the present coupling.
Public Member Functions inherited from olb::AbstractBlockO
virtual	~AbstractBlockO ()=default
virtual std::type_index	id () const =0

Detailed Description

template<typename COUPLEES>
struct olb::AbstractCouplingO< COUPLEES >

Base of block-wide coupling operators executed by SuperLatticeCoupling.

Definition at line 115 of file operator.h.

Member Typedef Documentation

AbstractParameters

template<typename COUPLEES >

using olb::AbstractCouplingO< COUPLEES >::AbstractParameters = olb::AbstractParameters<value_t,descriptor_t>

Definition at line 121 of file operator.h.

descriptor_t

template<typename COUPLEES >

using olb::AbstractCouplingO< COUPLEES >::descriptor_t = typename COUPLEES::values_t::template get<0>::descriptor_t

Descriptor type used for coupling parameters.

Definition at line 119 of file operator.h.

FieldD

template<typename COUPLEES >

template<typename FIELD >

using olb::AbstractCouplingO< COUPLEES >::FieldD = olb::FieldD<value_t,descriptor_t,FIELD>

Definition at line 126 of file operator.h.

LatticeR

template<typename COUPLEES >

using olb::AbstractCouplingO< COUPLEES >::LatticeR = olb::LatticeR<descriptor_t::d>

Definition at line 124 of file operator.h.

ParametersD

template<typename COUPLEES >

using olb::AbstractCouplingO< COUPLEES >::ParametersD = olb::ParametersD<value_t,descriptor_t>

Definition at line 122 of file operator.h.

value_t

template<typename COUPLEES >

using olb::AbstractCouplingO< COUPLEES >::value_t = typename COUPLEES::values_t::template get<0>::value_t

Value type used for coupling parameters.

Definition at line 117 of file operator.h.

Member Function Documentation

execute()

template<typename COUPLEES >

virtual void olb::AbstractCouplingO< COUPLEES >::execute ( )

pure virtual

Execute coupling operation.

Implemented in olb::ConcreteBlockCouplingO< COUPLEES, Platform::GPU_CUDA, COUPLER, OperatorScope::PerCell >, olb::ConcreteBlockCouplingO< COUPLEES, Platform::GPU_CUDA, COUPLER, OperatorScope::PerCellWithParameters >, olb::ConcreteBlockCouplingO< COUPLEES, PLATFORM, COUPLER, OperatorScope::PerCell >, and olb::ConcreteBlockCouplingO< COUPLEES, PLATFORM, COUPLER, OperatorScope::PerCellWithParameters >.

getParameters()

template<typename COUPLEES >

virtual AbstractParameters & olb::AbstractCouplingO< COUPLEES >::getParameters ( )

pure virtual

Return reference to parameters of coupling operator.

Implemented in olb::ConcreteBlockCouplingO< COUPLEES, Platform::GPU_CUDA, COUPLER, OperatorScope::PerCell >, olb::ConcreteBlockCouplingO< COUPLEES, Platform::GPU_CUDA, COUPLER, OperatorScope::PerCellWithParameters >, olb::ConcreteBlockCouplingO< COUPLEES, PLATFORM, COUPLER, OperatorScope::PerCell >, and olb::ConcreteBlockCouplingO< COUPLEES, PLATFORM, COUPLER, OperatorScope::PerCellWithParameters >.

set()

template<typename COUPLEES >

virtual void olb::AbstractCouplingO< COUPLEES >::set ( CellID iCell, bool state )

pure virtual

Set whether iCell is covered by the present coupling.

By default the entire non-overlap block area is coupled.

Implemented in olb::ConcreteBlockCouplingO< COUPLEES, Platform::GPU_CUDA, COUPLER, OperatorScope::PerCell >, olb::ConcreteBlockCouplingO< COUPLEES, Platform::GPU_CUDA, COUPLER, OperatorScope::PerCellWithParameters >, olb::ConcreteBlockCouplingO< COUPLEES, PLATFORM, COUPLER, OperatorScope::PerCell >, and olb::ConcreteBlockCouplingO< COUPLEES, PLATFORM, COUPLER, OperatorScope::PerCellWithParameters >.

---

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

• src/core/operator.h