olb::ConcreteBlockCouplingO< COUPLEES, PLATFORM, COUPLER, OperatorScope::PerCellWithParameters > Class Template Reference

#include <superLatticeCoupling.h>

Inheritance diagram for olb::ConcreteBlockCouplingO< COUPLEES, PLATFORM, COUPLER, OperatorScope::PerCellWithParameters >:

Collaboration diagram for olb::ConcreteBlockCouplingO< COUPLEES, PLATFORM, COUPLER, OperatorScope::PerCellWithParameters >:

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

Additional Inherited Members
Public Types inherited from olb::AbstractCouplingO< COUPLEES >
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>

Detailed Description

template<typename COUPLER, typename COUPLEES, Platform PLATFORM>
class olb::ConcreteBlockCouplingO< COUPLEES, PLATFORM, COUPLER, OperatorScope::PerCellWithParameters >

Definition at line 133 of file superLatticeCoupling.h.

Constructor & Destructor Documentation

ConcreteBlockCouplingO()

template<typename COUPLER , typename COUPLEES , Platform PLATFORM>

template<typename LATTICES >

olb::ConcreteBlockCouplingO< COUPLEES, PLATFORM, COUPLER, OperatorScope::PerCellWithParameters >::ConcreteBlockCouplingO ( LATTICES && lattices )

inline

Definition at line 163 of file superLatticeCoupling.h.

                                             :
    _lattices{lattices}
  { }

Member Function Documentation

execute()

template<typename COUPLER , typename COUPLEES , Platform PLATFORM>

void olb::ConcreteBlockCouplingO< COUPLEES, PLATFORM, COUPLER, OperatorScope::PerCellWithParameters >::execute ( )

inlineoverridevirtual

Execute coupling operation.

Implements olb::AbstractCouplingO< COUPLEES >.

Definition at line 186 of file superLatticeCoupling.h.

  {
    using loc = typename AbstractCouplingO<COUPLEES>::LatticeR::value_t;
    auto* lattice = _lattices.template get<0>();
    if (_mask) {
      #ifdef PARALLEL_MODE_OMP
      #pragma omp parallel for schedule(static) collapse(1)
      #endif
      for (loc iX=0; iX < lattice->getNx(); ++iX) {
        for (loc iY=0; iY < lattice->getNy(); ++iY) {
          if constexpr (AbstractCouplingO<COUPLEES>::descriptor_t::d == 3) {
            for (loc iZ=0; iZ < lattice->getNz(); ++iZ) {
              if (_mask->operator[](lattice->getCellId(iX,iY,iZ))) {
                execute({iX,iY,iZ});
              }
            }
          } else {
            if (_mask->operator[](lattice->getCellId(iX,iY))) {
              execute({iX,iY});
            }
          }
        }
      }
    } else {
      #ifdef PARALLEL_MODE_OMP
      #pragma omp parallel for schedule(static) collapse(1)
      #endif
      for (loc iX=0; iX < lattice->getNx(); ++iX) {
        for (loc iY=0; iY < lattice->getNy(); ++iY) {
          if constexpr (AbstractCouplingO<COUPLEES>::descriptor_t::d == 3) {
            for (loc iZ=0; iZ < lattice->getNz(); ++iZ) {
              execute({iX,iY,iZ});
            }
          } else {
            execute({iX,iY});
          }
        }
      }
    }
  }

getParameters()

template<typename COUPLER , typename COUPLEES , Platform PLATFORM>

AbstractCouplingO< COUPLEES >::AbstractParameters & olb::ConcreteBlockCouplingO< COUPLEES, PLATFORM, COUPLER, OperatorScope::PerCellWithParameters >::getParameters ( )

inlineoverridevirtual

Return reference to parameters of coupling operator.

Implements olb::AbstractCouplingO< COUPLEES >.

Definition at line 171 of file superLatticeCoupling.h.

                                                                                   {
    return _parameters;
  }

id()

template<typename COUPLER , typename COUPLEES , Platform PLATFORM>

std::type_index olb::ConcreteBlockCouplingO< COUPLEES, PLATFORM, COUPLER, OperatorScope::PerCellWithParameters >::id ( ) const

inlineoverridevirtual

Implements olb::AbstractBlockO.

Definition at line 167 of file superLatticeCoupling.h.

                                    {
    return typeid(COUPLER);
  }

set()

template<typename COUPLER , typename COUPLEES , Platform PLATFORM>

void olb::ConcreteBlockCouplingO< COUPLEES, PLATFORM, COUPLER, OperatorScope::PerCellWithParameters >::set ( CellID iCell, bool state )

inlineoverridevirtual

Set whether iCell is covered by the present coupling.

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

Implements olb::AbstractCouplingO< COUPLEES >.

Definition at line 175 of file superLatticeCoupling.h.

  {
    if (!_mask) {
      _mask = std::make_unique<ConcreteBlockMask<typename COUPLEES::values_t::template get<0>::value_t,
                                                 PLATFORM>>(
        _lattices.template get<0>()->template getData<CollisionSubdomainMask>()
      );
    }
    _mask->set(iCell, state);
  }

---

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

• src/core/superLatticeCoupling.h