LBIBCell
 All Classes Functions Variables Friends Pages
LbmLib::solver::DiracD2Q5 Class Reference

the cde solver for the schnakenberg turing pattern More...

#include <DiracD2Q5.hpp>

Inheritance diagram for LbmLib::solver::DiracD2Q5:
LbmLib::solver::BaseCDESolver< DiracD2Q5 > LbmLib::solver::CDEAbstractSolver LbmLib::solver::AbstractSolver

Public Member Functions

virtual ~DiracD2Q5 ()
 ~CDESolverD2Q4 virtual Destructor
 
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< DiracD2Q5 >
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
 

Additional Inherited Members

- Protected Member Functions inherited from LbmLib::solver::BaseCDESolver< DiracD2Q5 >
 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< DiracD2Q5 >
static CDEAbstractSolvercreate ()
 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::PhysicalNodephysicalNode_
 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< DiracD2Q5 >
static bool reg
 reg True if registration was successful
 

Detailed Description

the cde solver for the schnakenberg turing pattern

Definition at line 33 of file DiracD2Q5.hpp.

Member Function Documentation

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

accessDistribution Access to the distribution

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

Implements LbmLib::solver::AbstractSolver.

Definition at line 86 of file DiracD2Q5.cpp.

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

calculateEquilibrium calculates the equilibirum for direction dir

Parameters
dirthe direction
Returns
the Equilibrium

Implements LbmLib::solver::CDEAbstractSolver.

Definition at line 135 of file DiracD2Q5.cpp.

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

getC Calculates the concentration on this node

Returns
The concentration on this node

Implements LbmLib::solver::CDEAbstractSolver.

Definition at line 97 of file DiracD2Q5.cpp.

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

loads the solver from the stream

Parameters
streamthe stream where the solver is loaded from

Implements LbmLib::solver::AbstractSolver.

Definition at line 76 of file DiracD2Q5.cpp.

void LbmLib::solver::DiracD2Q5::rescaleDistributions ( const double  factor)
virtual

Rescales all distributions by a factor.

Parameters
factorThe rescaling factor.

Implements LbmLib::solver::AbstractSolver.

Definition at line 91 of file DiracD2Q5.cpp.

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

writes the solver to the stream

Parameters
streamthe stream where the solver is written to

Implements LbmLib::solver::AbstractSolver.

Definition at line 68 of file DiracD2Q5.cpp.


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