maia::lb::LbSrcTermController< nDim, nDist, SysEqn > Class Template Reference

Front-end to control all source terms in a wrapping manner. More...

#include <lbsrctermcontroller.h>

Collaboration diagram for maia::lb::LbSrcTermController< nDim, nDist, SysEqn >:

Public Member Functions
	LbSrcTermController (LbSolverDxQy< nDim, nDist, SysEqn > *p_solver)
void	init ()
	Initialize the source term controller. More...
void	initSrcTerms ()
	Initialize the source term controller. More...
void	addSrcTerm (const MString &p_name)
	Add a source term to the controller by its property tag. More...
void	apply_preCollision ()
	Call the pre collision routines of all source terms. More...
void	apply_postCollision ()
	Call the post collision routines of all source terms. More...
void	apply_postPropagation ()
	Call the post collision routines of all source terms. More...

Private Attributes
LbSolverDxQy< nDim, nDist, SysEqn > *	m_solver
MInt	m_noSrcTerms {}
std::vector< std::unique_ptr< LbSrcTerm< nDim, nDist, SysEqn > > >	m_srcTerms

Detailed Description

template<MInt nDim, MInt nDist, class SysEqn>
class maia::lb::LbSrcTermController< nDim, nDist, SysEqn >

Author

Miro Gondrum

Date

01.02.2022

Definition at line 106 of file lbsrctermcontroller.h.

Constructor & Destructor Documentation

LbSrcTermController()

template<MInt nDim, MInt nDist, class SysEqn >

maia::lb::LbSrcTermController< nDim, nDist, SysEqn >::LbSrcTermController ( LbSolverDxQy< nDim, nDist, SysEqn > *  p_solver )

inline

Definition at line 108 of file lbsrctermcontroller.h.

: m_solver(p_solver){};

Member Function Documentation

addSrcTerm()

template<MInt nDim, MInt nDist, class SysEqn >

void maia::lb::LbSrcTermController< nDim, nDist, SysEqn >::addSrcTerm

(

const MString &

p_name

)

Author

Miro Gondrum

Date

01.02.2022

Parameters

[in]

p_name

The name of the source term

Definition at line 169 of file lbsrctermcontroller.h.

                                                                               {
  TRACE();
  m_srcTerms.emplace_back(LbSrcTermFactory<nDim, nDist, SysEqn>::instance()->create_srcTerm(p_name, m_solver));
}

apply_postCollision()

template<MInt nDim, MInt nDist, class SysEqn >

void maia::lb::LbSrcTermController< nDim, nDist, SysEqn >::apply_postCollision

Author

Miro Gondrum

Date

01.02.2022

Definition at line 191 of file lbsrctermcontroller.h.

                                                                   {
  TRACE();
  for(auto& srcTerm : m_srcTerms) {
    srcTerm->apply_postCollision();
  }
}

apply_postPropagation()

template<MInt nDim, MInt nDist, class SysEqn >

void maia::lb::LbSrcTermController< nDim, nDist, SysEqn >::apply_postPropagation

Author

Julian Vorspohl

Date

01.05.2024

Definition at line 203 of file lbsrctermcontroller.h.

                                                                     {
  TRACE();
  for(auto& srcTerm : m_srcTerms) {
    srcTerm->apply_postPropagation();
  }
}

apply_preCollision()

template<MInt nDim, MInt nDist, class SysEqn >

void maia::lb::LbSrcTermController< nDim, nDist, SysEqn >::apply_preCollision

Author

Miro Gondrum

Date

01.02.2022

Definition at line 179 of file lbsrctermcontroller.h.

                                                                  {
  TRACE();
  for(auto& srcTerm : m_srcTerms) {
    srcTerm->apply_preCollision();
  }
}

init()

template<MInt nDim, MInt nDist, class SysEqn >

void maia::lb::LbSrcTermController< nDim, nDist, SysEqn >::init

Author

Miro Gondrum

Date

01.02.2022

Definition at line 128 of file lbsrctermcontroller.h.

                                                    {
  TRACE();
  std::stringstream ss;
  ss << "- Init source terms:" << std::endl;
  m_noSrcTerms = 0;
  if(Context::propertyExists("lbSrcTerms", m_solver->m_solverId)) {
    m_noSrcTerms = Context::propertyLength("lbSrcTerms");
  }
  m_srcTerms.clear();
  ss << " no source terms =" << m_noSrcTerms << std::endl;
  ss << "  ";
  if(m_noSrcTerms > 0) {
    for(MInt i = 0; i < m_noSrcTerms; i++) {
      const MString srcTermName = Context::getBasicProperty<MString>("lbSrcTerms", AT_, &srcTermName, i);
      m_srcTerms.emplace_back(LbSrcTermFactory<nDim, nDist, SysEqn>::instance()->create_srcTerm(srcTermName, m_solver));
      ss << srcTermName << " ";
    }
    ss << std::endl;
    m_log << ss.str();
    if(m_solver->domainId() == 0) std::cout << ss.str();
  }
}

initSrcTerms()

template<MInt nDim, MInt nDist, class SysEqn >

void maia::lb::LbSrcTermController< nDim, nDist, SysEqn >::initSrcTerms

Author

Julian Vorspohl

Date

01.05.2024

Definition at line 156 of file lbsrctermcontroller.h.

                                                            {
  // Call init routine for each source term instance created
  for(auto& srcTerm : m_srcTerms) {
    srcTerm->init();
  }
}

Member Data Documentation

m_noSrcTerms

template<MInt nDim, MInt nDist, class SysEqn >

MInt maia::lb::LbSrcTermController< nDim, nDist, SysEqn >::m_noSrcTerms {}

private

Definition at line 119 of file lbsrctermcontroller.h.

m_solver

template<MInt nDim, MInt nDist, class SysEqn >

LbSolverDxQy<nDim, nDist, SysEqn>* maia::lb::LbSrcTermController< nDim, nDist, SysEqn >::m_solver

private

Definition at line 118 of file lbsrctermcontroller.h.

m_srcTerms

template<MInt nDim, MInt nDist, class SysEqn >

std::vector<std::unique_ptr<LbSrcTerm<nDim, nDist, SysEqn> > > maia::lb::LbSrcTermController< nDim, nDist, SysEqn >::m_srcTerms

private

Definition at line 120 of file lbsrctermcontroller.h.

---

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

• /home/gitlab-runner/scratch/builds/oxpnswJ6/1/aia/m-AIA/m-AIA/src/LB/lbsrctermcontroller.h