maia::lb::LbSrcTerm< nDim_, nDist_, SysEqn_ > Class Template Reference

Abstract class for lb source terms. More...

#include <lbsrcterm.h>

Inheritance diagram for maia::lb::LbSrcTerm< nDim_, nDist_, SysEqn_ >:

Public Types
using	SysEqn = SysEqn_

Public Member Functions
virtual void	init ()=0
virtual void	apply_preCollision ()=0
virtual void	apply_postCollision ()=0
virtual void	apply_postPropagation ()=0
virtual	~LbSrcTerm ()=default

Static Public Attributes
static constexpr MInt	nDim = nDim_
static constexpr MInt	nDist = nDist_

Protected Member Functions
virtual void	readProperties ()=0

Detailed Description

template<MInt nDim_, MInt nDist_, class SysEqn_>
class maia::lb::LbSrcTerm< nDim_, nDist_, SysEqn_ >

Author

Miro Gondrum

Date

01.02.2022

Definition at line 22 of file lbsrcterm.h.

Member Typedef Documentation

SysEqn

template<MInt nDim_, MInt nDist_, class SysEqn_ >

using maia::lb::LbSrcTerm< nDim_, nDist_, SysEqn_ >::SysEqn = SysEqn_

Definition at line 29 of file lbsrcterm.h.

Constructor & Destructor Documentation

~LbSrcTerm()

template<MInt nDim_, MInt nDist_, class SysEqn_ >

virtual maia::lb::LbSrcTerm< nDim_, nDist_, SysEqn_ >::~LbSrcTerm ( )

virtualdefault

Member Function Documentation

apply_postCollision()

template<MInt nDim_, MInt nDist_, class SysEqn_ >

virtual void maia::lb::LbSrcTerm< nDim_, nDist_, SysEqn_ >::apply_postCollision ( )

pure virtual

Implemented in maia::lb::LbSrcTerm_monopole< nDim, nDist, SysEqn >, maia::lb::LbSrcTermGravity< nDim, nDist, SysEqn >, maia::lb::LbSrcTerm_nonnewtonian< nDim, nDist, SysEqn >, maia::lb::LbSrcTerm_smagorinsky< nDim, nDist, SysEqn, bubble >, maia::lb::LbSrcTerm_spongeRhoConst< nDim, nDist, SysEqn >, maia::lb::LbSrcTerm_spongeEqConst< nDim, nDist, SysEqn >, and maia::lb::LbSrcTerm_spongeVisocity< nDim, nDist, SysEqn >.

apply_postPropagation()

template<MInt nDim_, MInt nDist_, class SysEqn_ >

virtual void maia::lb::LbSrcTerm< nDim_, nDist_, SysEqn_ >::apply_postPropagation ( )

pure virtual

Implemented in maia::lb::LbSrcTerm_monopole< nDim, nDist, SysEqn >, maia::lb::LbSrcTermGravity< nDim, nDist, SysEqn >, maia::lb::LbSrcTerm_nonnewtonian< nDim, nDist, SysEqn >, maia::lb::LbSrcTerm_smagorinsky< nDim, nDist, SysEqn, bubble >, maia::lb::LbSrcTerm_spongeRhoConst< nDim, nDist, SysEqn >, maia::lb::LbSrcTerm_spongeEqConst< nDim, nDist, SysEqn >, and maia::lb::LbSrcTerm_spongeVisocity< nDim, nDist, SysEqn >.

apply_preCollision()

template<MInt nDim_, MInt nDist_, class SysEqn_ >

virtual void maia::lb::LbSrcTerm< nDim_, nDist_, SysEqn_ >::apply_preCollision ( )

pure virtual

Implemented in maia::lb::LbSrcTerm_monopole< nDim, nDist, SysEqn >, maia::lb::LbSrcTermGravity< nDim, nDist, SysEqn >, maia::lb::LbSrcTerm_nonnewtonian< nDim, nDist, SysEqn >, maia::lb::LbSrcTerm_smagorinsky< nDim, nDist, SysEqn, bubble >, maia::lb::LbSrcTerm_spongeRhoConst< nDim, nDist, SysEqn >, maia::lb::LbSrcTerm_spongeEqConst< nDim, nDist, SysEqn >, and maia::lb::LbSrcTerm_spongeVisocity< nDim, nDist, SysEqn >.

init()

template<MInt nDim_, MInt nDist_, class SysEqn_ >

virtual void maia::lb::LbSrcTerm< nDim_, nDist_, SysEqn_ >::init ( )

pure virtual

Implemented in maia::lb::LbSrcTerm_monopole< nDim, nDist, SysEqn >, maia::lb::LbSrcTermGravity< nDim, nDist, SysEqn >, maia::lb::LbSrcTerm_nonnewtonian< nDim, nDist, SysEqn >, maia::lb::LbSrcTerm_smagorinsky< nDim, nDist, SysEqn, bubble >, maia::lb::LbSrcTerm_spongeEqConst< nDim, nDist, SysEqn >, and maia::lb::LbSrcTerm_sponge< nDim, nDist, SysEqn >.

readProperties()

template<MInt nDim_, MInt nDist_, class SysEqn_ >

virtual void maia::lb::LbSrcTerm< nDim_, nDist_, SysEqn_ >::readProperties ( )

protectedpure virtual

Implemented in maia::lb::LbSrcTerm_monopole< nDim, nDist, SysEqn >, maia::lb::LbSrcTermGravity< nDim, nDist, SysEqn >, maia::lb::LbSrcTerm_nonnewtonian< nDim, nDist, SysEqn >, maia::lb::LbSrcTerm_smagorinsky< nDim, nDist, SysEqn, bubble >, and maia::lb::LbSrcTerm_sponge< nDim, nDist, SysEqn >.

Member Data Documentation

nDim

template<MInt nDim_, MInt nDist_, class SysEqn_ >

constexpr MInt maia::lb::LbSrcTerm< nDim_, nDist_, SysEqn_ >::nDim = nDim_

staticconstexpr

Definition at line 27 of file lbsrcterm.h.

nDist

template<MInt nDim_, MInt nDist_, class SysEqn_ >

constexpr MInt maia::lb::LbSrcTerm< nDim_, nDist_, SysEqn_ >::nDist = nDist_

staticconstexpr

Definition at line 28 of file lbsrcterm.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/lbsrcterm.h