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

the base class of the cde and fluid solvers More...

#include <AbstractSolver.hpp>

Inheritance diagram for LbmLib::solver::AbstractSolver:
LbmLib::solver::CDEAbstractSolver LbmLib::solver::FluidSolver LbmLib::solver::FluidSolver LbmLib::solver::BaseCDESolver< CDESolverD2Q4 > LbmLib::solver::BaseCDESolver< CDESolverD2Q5 > LbmLib::solver::BaseCDESolver< CDESolverD2Q5BMP > LbmLib::solver::BaseCDESolver< CDESolverD2Q5HH > LbmLib::solver::BaseCDESolver< DiracD2Q4 > LbmLib::solver::BaseCDESolver< DiracD2Q5 > LbmLib::solver::BaseCDESolver< SchnakenbergD2Q4u > LbmLib::solver::BaseCDESolver< SchnakenbergD2Q4v > LbmLib::solver::BaseCDESolver< SchnakenbergD2Q5u > LbmLib::solver::BaseCDESolver< SchnakenbergD2Q5v > LbmLib::solver::BaseCDESolver< tutorial_01_CDESolverD2Q5_SIGNAL > LbmLib::solver::BaseCDESolver< tutorial_02_CDESolverD2Q5_L > LbmLib::solver::BaseCDESolver< tutorial_02_CDESolverD2Q5_R > LbmLib::solver::BaseCDESolver< T >

Public Member Functions

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

 AbstractSolver ()
 AbstractSolver Protected to disable direct instantiation.
 

Detailed Description

the base class of the cde and fluid solvers

Definition at line 33 of file AbstractSolver.hpp.

Member Function Documentation

virtual double& LbmLib::solver::AbstractSolver::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::FluidSolver, LbmLib::solver::tutorial_01_CDESolverD2Q5_SIGNAL, LbmLib::solver::tutorial_02_CDESolverD2Q5_L, LbmLib::solver::tutorial_02_CDESolverD2Q5_R, LbmLib::solver::FluidSolver, 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.

double LbmLib::solver::AbstractSolver::getTau ( ) const
inline

getTau Getter method for the tau parameter

Returns
The tau of this solver

Definition at line 93 of file AbstractSolver.hpp.

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

loads the solver from the stream

Parameters
streamthe stream where the solver is loaded from

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, LbmLib::solver::SchnakenbergD2Q5v, LbmLib::solver::FluidSolver, and LbmLib::solver::FluidSolver.

virtual void LbmLib::solver::AbstractSolver::rescaleDistributions ( const double  factor)
pure virtual

Rescales all distributions by a factor.

Parameters
factorThe rescaling ractor

Implemented in LbmLib::solver::FluidSolver, LbmLib::solver::tutorial_01_CDESolverD2Q5_SIGNAL, LbmLib::solver::tutorial_02_CDESolverD2Q5_L, LbmLib::solver::tutorial_02_CDESolverD2Q5_R, LbmLib::solver::FluidSolver, 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.

void LbmLib::solver::AbstractSolver::setTau ( double  tau)
inline

setTau Setter method for the tau parameter of the solver

Parameters
tauThe new value of tau

Definition at line 85 of file AbstractSolver.hpp.

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

writes the solver to the stream

Parameters
streamthe stream where the solver is written to
Attention
the first two parameters must be the x and y position

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, LbmLib::solver::SchnakenbergD2Q5v, LbmLib::solver::FluidSolver, and LbmLib::solver::FluidSolver.

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