The tutorial_01_CDESolverD2Q5_SIGNAL class. More...

#include <tutorial_01_CDESolverD2Q5_SIGNAL.hpp>

Inheritance diagram for LbmLib::solver::tutorial_01_CDESolverD2Q5_SIGNAL:

Public Member Functions
virtual	~tutorial_01_CDESolverD2Q5_SIGNAL ()
	~CDESolverD2Q5 virtual Destructor

const double	reaction (void) const
	reaction The reaction term of the tutorial_01_CDESolverD2Q5_SIGNAL solver is implemented here. More...

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

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

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

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

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

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

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

virtual void	reinitialise ()
	reinitialise this solver as the corresponding physical node has switched domain

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

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

Public Member Functions inherited from LbmLib::solver::BaseCDESolver< tutorial_01_CDESolverD2Q5_SIGNAL >
std::string	getName ()
	getName More...

Public Member Functions inherited from LbmLib::solver::CDEAbstractSolver
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...

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

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

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...

Friends
class	BaseCDESolver
	the BaseCDESolver has to be a friend.

Additional Inherited Members
Protected Member Functions inherited from LbmLib::solver::BaseCDESolver< tutorial_01_CDESolverD2Q5_SIGNAL >
	BaseCDESolver ()
	BaseCDESolver The Constructor which enforces that the specialisation is done.

virtual	~BaseCDESolver ()
	~BaseCDESolver virtual Destructor

Protected Member Functions inherited from LbmLib::solver::CDEAbstractSolver
	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.

Static Protected Member Functions inherited from LbmLib::solver::BaseCDESolver< tutorial_01_CDESolverD2Q5_SIGNAL >
static CDEAbstractSolver *	create ()
	Create static constructor. A pointer to this function along with the name of the algorithm is registered with the Solver Factory. More...

static bool	init ()
	init Registers the class in the Solver Factory More...

Protected Attributes inherited from LbmLib::solver::CDEAbstractSolver
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).

Static Protected Attributes inherited from LbmLib::solver::BaseCDESolver< tutorial_01_CDESolverD2Q5_SIGNAL >
static bool	reg
	reg True if registration was successful

Detailed Description

The tutorial_01_CDESolverD2Q5_SIGNAL class.

Definition at line 34 of file tutorial_01_CDESolverD2Q5_SIGNAL.hpp.

Member Function Documentation

double & LbmLib::solver::tutorial_01_CDESolverD2Q5_SIGNAL::accessDistribution ( const Direction & dir )

virtual

accessDistribution Access to the distribution

Parameters

dir	the direction where the Distribution is wanted

Returns: A Reference to the Distribution

Implements LbmLib::solver::AbstractSolver.

Definition at line 77 of file tutorial_01_CDESolverD2Q5_SIGNAL.cpp.

double LbmLib::solver::tutorial_01_CDESolverD2Q5_SIGNAL::calculateEquilibrium ( const Direction & dir )

virtual

calculateEquilibrium calculates the equilibirum for direction dir

Parameters

dir	the direction

Returns: the Equilibrium

Implements LbmLib::solver::CDEAbstractSolver.

Definition at line 137 of file tutorial_01_CDESolverD2Q5_SIGNAL.cpp.

double LbmLib::solver::tutorial_01_CDESolverD2Q5_SIGNAL::getC ( ) const

virtual

getC Calculates the concentration on this node

Returns: The concentration on this node

Implements LbmLib::solver::CDEAbstractSolver.

Definition at line 88 of file tutorial_01_CDESolverD2Q5_SIGNAL.cpp.

void LbmLib::solver::tutorial_01_CDESolverD2Q5_SIGNAL::loadSolver ( std::stringstream *const stream )

virtual

loads the solver from the stream

Parameters

stream the stream where the solver is loaded from

Implements LbmLib::solver::AbstractSolver.

Definition at line 67 of file tutorial_01_CDESolverD2Q5_SIGNAL.cpp.

const double LbmLib::solver::tutorial_01_CDESolverD2Q5_SIGNAL::reaction ( void ) const

reaction The reaction term of the tutorial_01_CDESolverD2Q5_SIGNAL solver is implemented here.

Returns: The reaction term

Definition at line 92 of file tutorial_01_CDESolverD2Q5_SIGNAL.cpp.

void LbmLib::solver::tutorial_01_CDESolverD2Q5_SIGNAL::rescaleDistributions ( const double factor )

virtual

Rescales all distributions by a factor.

Parameters

factor The rescaling factor.

Implements LbmLib::solver::AbstractSolver.

Definition at line 82 of file tutorial_01_CDESolverD2Q5_SIGNAL.cpp.

void LbmLib::solver::tutorial_01_CDESolverD2Q5_SIGNAL::writeSolver ( std::ostream *const stream )

virtual

writes the solver to the stream

Parameters

stream the stream where the solver is written to

Implements LbmLib::solver::AbstractSolver.

Definition at line 59 of file tutorial_01_CDESolverD2Q5_SIGNAL.cpp.

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

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

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation