The abstract base class for all CDESolvers. More...

#include <CDEAbstractSolver.hpp>

Inheritance diagram for LbmLib::solver::CDEAbstractSolver:

Public Member Functions
virtual	~CDEAbstractSolver ()
	~CDEAbstractSolver virtual Destructor

void	initCDESolver (const nodes::PhysicalNode *physicalNode, size_t id)
	initCDESolver This connects the Solver with an physical node this should be executed before using this class More...

virtual double	calculateEquilibrium (const Direction &dir)=0
	calculateEquilibrium calculates the equilibirum for direction dir More...

virtual double	getC () const =0
	getC Calculates the concentration on this node More...

virtual void	reinitialise ()=0
	reinitialise this solver iff the corresponding physical node has changed domain identifier

virtual std::string	getName ()=0
	Get the name of the solver. More...

size_t	getId ()
	return the id of this solver More...

Public Member Functions inherited from LbmLib::solver::AbstractSolver
virtual	~AbstractSolver ()
	~AbstractSolver Destructor

virtual void	initSolver ()=0
	initSolver Use this to initalise the solver

virtual void	collide ()=0
	collide The collision step of the LBM

virtual void	advect ()=0
	advect The advect step of the LBM

virtual void	loadSolver (std::stringstream *const stream)=0
	loads the solver from the stream More...

virtual void	writeSolver (std::ostream *const stream)=0
	writes the solver to the stream More...

virtual double &	accessDistribution (const Direction &dir)=0
	accessDistribution Access to the distribution More...

virtual void	rescaleDistributions (const double factor)=0
	Rescales all distributions by a factor. More...

void	setTau (double tau)
	setTau Setter method for the tau parameter of the solver More...

double	getTau () const
	getTau Getter method for the tau parameter More...

Protected Member Functions
	CDEAbstractSolver ()
	CDEAbstractSolver protected Constructor only use create method for instantiation.

Protected Member Functions inherited from LbmLib::solver::AbstractSolver
	AbstractSolver ()
	AbstractSolver Protected to disable direct instantiation.

Protected Attributes
const nodes::PhysicalNode *	physicalNode_
	physicalNode_ The physical Node which owns this solver

size_t	solverID_
	solverID_ The ID of the solver instance. Coincides with the index in the vector PhysicalNode::cdeSolvers_ (which stores all CDE solvers).

Detailed Description

The abstract base class for all CDESolvers.

Attention: Do not inherit from this class! Use class BaseCDESolver instead, as the latter class will register the class automatically

Definition at line 39 of file CDEAbstractSolver.hpp.

Member Function Documentation

virtual double LbmLib::solver::CDEAbstractSolver::calculateEquilibrium ( const Direction & dir )

pure virtual

calculateEquilibrium calculates the equilibirum for direction dir

Parameters

dir	the direction

Returns: the Equilibrium

Implemented in LbmLib::solver::tutorial_01_CDESolverD2Q5_SIGNAL, LbmLib::solver::tutorial_02_CDESolverD2Q5_L, LbmLib::solver::tutorial_02_CDESolverD2Q5_R, LbmLib::solver::CDESolverD2Q5, LbmLib::solver::CDESolverD2Q4, LbmLib::solver::CDESolverD2Q5BMP, LbmLib::solver::CDESolverD2Q5HH, LbmLib::solver::DiracD2Q4, LbmLib::solver::DiracD2Q5, LbmLib::solver::SchnakenbergD2Q4u, LbmLib::solver::SchnakenbergD2Q4v, LbmLib::solver::SchnakenbergD2Q5u, and LbmLib::solver::SchnakenbergD2Q5v.

virtual double LbmLib::solver::CDEAbstractSolver::getC ( ) const

pure virtual

getC Calculates the concentration on this node

Returns: The concentration on this node

Implemented in LbmLib::solver::tutorial_01_CDESolverD2Q5_SIGNAL, LbmLib::solver::tutorial_02_CDESolverD2Q5_L, LbmLib::solver::tutorial_02_CDESolverD2Q5_R, LbmLib::solver::CDESolverD2Q5, LbmLib::solver::CDESolverD2Q4, LbmLib::solver::CDESolverD2Q5BMP, LbmLib::solver::CDESolverD2Q5HH, LbmLib::solver::DiracD2Q4, LbmLib::solver::DiracD2Q5, LbmLib::solver::SchnakenbergD2Q4u, LbmLib::solver::SchnakenbergD2Q4v, LbmLib::solver::SchnakenbergD2Q5u, and LbmLib::solver::SchnakenbergD2Q5v.

size_t LbmLib::solver::CDEAbstractSolver::getId ( )

return the id of this solver

Returns: the id of this solver

Definition at line 38 of file CDEAbstractSolver.cpp.

virtual std::string LbmLib::solver::CDEAbstractSolver::getName ( )

pure virtual

Get the name of the solver.

Returns: the name of the solver

void LbmLib::solver::CDEAbstractSolver::initCDESolver	(	const nodes::PhysicalNode *	physicalNode,
		size_t	id
	)

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

Parameters

physicalNode	The node this solver is connected to.
id	The id of this solver

Definition at line 31 of file CDEAbstractSolver.cpp.

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

/home/tanakas/Documents/13_LBMCELL/lbmsolver/libs/LbmLib/include/solver/CDESolver/CDEAbstractSolver.hpp
/home/tanakas/Documents/13_LBMCELL/lbmsolver/libs/LbmLib/src/solver/CDESolver/CDEAbstractSolver.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation