LBIBCell
 All Classes Functions Variables Friends Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
LbmLib::solver::BoundaryAbstractSolver Class Referenceabstract

The BoundaryAbstractSolver class The abstract base class for all Boundary Solvers. More...

#include <BoundaryAbstractSolver.hpp>

Inheritance diagram for LbmLib::solver::BoundaryAbstractSolver:
LbmLib::solver::BaseBoundarySolver< BoundarySolverNoFlux > LbmLib::solver::BaseBoundarySolver< BoundarySolverNoFluxD2Q5 > LbmLib::solver::BaseBoundarySolver< T > LbmLib::solver::BoundarySolverNoFlux LbmLib::solver::BoundarySolverNoFluxD2Q5

Public Member Functions

virtual ~BoundaryAbstractSolver ()
 ~BoundaryAbstractSolver virtual Destructor
 
void connectBoundaryNode (const nodes::BoundaryNode *boundaryNode)
 connectPhysicalNode This connects the Solver with an physical node this should be executed before using this class More...
 
virtual void advect ()=0
 advect The advect step of the LBM
 
virtual void postAdvect ()=0
 postAdvect Executed after the advection step
 
virtual void preAdvect ()=0
 preAdvect Executed before the advection step
 
virtual void initSolver ()=0
 initSolver Use this to initalise the solver
 
void connectToCDESolvers (const std::vector< std::string > &cdeSolvers)
 connectToCDESolvers makes sure that this boundary Solver is executed on all connected CDE Solvers More...
 
virtual double & accessDistribution (const Direction &dir)=0
 accessDistribution Access to the distribution More...
 

Protected Member Functions

 BoundaryAbstractSolver ()
 CDESolver protected Constructor only use create method for instantiation.
 

Protected Attributes

const nodes::BoundaryNode * boundaryNode_
 physicalNode_ The physical Node which owns this solver
 
std::vector< std::string > cdeSolvers_
 cdeSolvers_ The cde solver this boundary solver is responsible for.
 

Detailed Description

The BoundaryAbstractSolver class The abstract base class for all Boundary Solvers.

Attention
Do not inherit from this class use class BaseBoundarySolver instead, as this will then register the class automatically

Definition at line 40 of file BoundaryAbstractSolver.hpp.

Member Function Documentation

virtual double& LbmLib::solver::BoundaryAbstractSolver::accessDistribution ( const Direction &  dir)
pure virtual

accessDistribution Access to the distribution

Parameters
dirthe direction where the Distribution is wanted
Returns
A Reference to the Distribution

Implemented in LbmLib::solver::BoundarySolverNoFlux, and LbmLib::solver::BoundarySolverNoFluxD2Q5.

void LbmLib::solver::BoundaryAbstractSolver::connectBoundaryNode ( const nodes::BoundaryNode *  boundaryNode)

connectPhysicalNode This connects the Solver with an physical node this should be executed before using this class

Parameters
boundaryNodeThe node this solver is connected to.

Definition at line 32 of file BoundaryAbstractSolver.cpp.

void LbmLib::solver::BoundaryAbstractSolver::connectToCDESolvers ( const std::vector< std::string > &  cdeSolvers)

connectToCDESolvers makes sure that this boundary Solver is executed on all connected CDE Solvers

Parameters
cdeSolversa vector of strings with the names of the corresponding Solvers

Definition at line 37 of file BoundaryAbstractSolver.cpp.

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