LBIBCell
 All Classes Functions Variables Friends Pages
LbmLib::SimulationRunner Class Reference

the main simulation class More...

#include <SimulationRunner.hpp>

Public Member Functions

 SimulationRunner (const geometry::GeometryHandler &geometry, const reportHandler::ReportHandler &reportHandler)
 constructor More...
 
 ~SimulationRunner ()
 Destructor.
 
void runSimulation ()
 runSimulation Runs the main Simulation loop
 
void writeSimulation (const std::string &forceFileName, const std::string &geometryFileName, const std::string &parameterFileName, const std::string &solverFileName) const
 writes the simulation to the files More...
 
void initSolvers (Field< double > fluidVelocity)
 initSolvers Initialises the solvers More...
 
void initSolvers ()
 initSolvers Initialises the solvers
 
void initSolvers (const std::string &filename)
 Initialised the Solvers from a file. More...
 
void addMassSolver (const std::string &name)
 adds a mass solver to the simulation More...
 
void addBioSolver (const std::string &name)
 Adds a BioSolver. More...
 
void initForceSolver (const std::string &fileName)
 Inits the Force solver to calculate the forces on the geometry nodes. More...
 
const solver::ForceSolvergetForceSolver (void)
 getForceSolver Returns a reference to the solver::ForceSolver More...
 

Detailed Description

the main simulation class

Definition at line 43 of file SimulationRunner.hpp.

Constructor & Destructor Documentation

LbmLib::SimulationRunner::SimulationRunner ( const geometry::GeometryHandler geometry,
const reportHandler::ReportHandler reportHandler 
)
explicit

constructor

Parameters
geometrythe geometry handler
reportHandlerthe report handler

Definition at line 50 of file SimulationRunner.cpp.

Member Function Documentation

void LbmLib::SimulationRunner::addBioSolver ( const std::string &  name)

Adds a BioSolver.

Parameters
nameThe name of the BioSolver.

Definition at line 405 of file SimulationRunner.cpp.

void LbmLib::SimulationRunner::addMassSolver ( const std::string &  name)

adds a mass solver to the simulation

Parameters
namethe name of the mass solver

Definition at line 401 of file SimulationRunner.cpp.

const solver::ForceSolver & LbmLib::SimulationRunner::getForceSolver ( void  )

getForceSolver Returns a reference to the solver::ForceSolver

Returns
reference to the solver::ForceSolver

Definition at line 396 of file SimulationRunner.cpp.

void LbmLib::SimulationRunner::initForceSolver ( const std::string &  fileName)

Inits the Force solver to calculate the forces on the geometry nodes.

Parameters
fileNameThe name of the Force solver input file

Definition at line 392 of file SimulationRunner.cpp.

void LbmLib::SimulationRunner::initSolvers ( Field< double >  fluidVelocity)

initSolvers Initialises the solvers

Parameters
fluidVelocityThe initial Speed of the fluid

Definition at line 308 of file SimulationRunner.cpp.

void LbmLib::SimulationRunner::initSolvers ( const std::string &  filename)

Initialised the Solvers from a file.

Parameters
filenamethe file name where the solvers are stored

Definition at line 151 of file SimulationRunner.cpp.

void LbmLib::SimulationRunner::writeSimulation ( const std::string &  forceFileName,
const std::string &  geometryFileName,
const std::string &  parameterFileName,
const std::string &  solverFileName 
) const

writes the simulation to the files

Parameters
forceFileNamethe name of the file where the forces are stored
geometryFileNamethe name of the file where the geometry is stored
parameterFileNamethe filename where the parameters are stored
solverFileNamethe name of the file wher the solvers are stored

Definition at line 112 of file SimulationRunner.cpp.


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