olb::parameters::SimulationBase< T > Struct Template Reference

Base struct to keep the parameters that are necessary for the simulation. More...

#include <solverParameters.h>

Inheritance diagram for olb::parameters::SimulationBase< T >:

Collaboration diagram for olb::parameters::SimulationBase< T >:

Public Types
using	BT = BaseType<T>

Public Member Functions
virtual void	initialize ()

Public Attributes
BT	startUpTime {0}
BT	maxTime {1}
BT	physBoundaryValueUpdateTime {0.1}
BT	physTimeStabilityCheck {0.1}
bool	pressureFilter {false}
int	noC {1}
int	overlap {3}

Detailed Description

template<typename T>
struct olb::parameters::SimulationBase< T >

Base struct to keep the parameters that are necessary for the simulation.

Class supports reading simulation parameters from input files (e.g. XML) as well as an interface for other parts of the program. This class is intended to be derived from: at least, a UnitConverter has to be provided additionally.

Definition at line 54 of file solverParameters.h.

Member Typedef Documentation

BT

template<typename T >

using olb::parameters::SimulationBase< T >::BT = BaseType<T>

Definition at line 56 of file solverParameters.h.

Member Function Documentation

initialize()

template<typename T >

virtual void olb::parameters::SimulationBase< T >::initialize ( )

inlinevirtual

Reimplemented from olb::parameters::ParameterBase.

Definition at line 69 of file solverParameters.h.

{ }

Member Data Documentation

maxTime

template<typename T >

BT olb::parameters::SimulationBase< T >::maxTime {1}

Definition at line 59 of file solverParameters.h.

{1};

noC

template<typename T >

int olb::parameters::SimulationBase< T >::noC {1}

Definition at line 66 of file solverParameters.h.

{1};

overlap

template<typename T >

int olb::parameters::SimulationBase< T >::overlap {3}

Definition at line 67 of file solverParameters.h.

{3};

physBoundaryValueUpdateTime

template<typename T >

BT olb::parameters::SimulationBase< T >::physBoundaryValueUpdateTime {0.1}

Definition at line 60 of file solverParameters.h.

{0.1};

physTimeStabilityCheck

template<typename T >

BT olb::parameters::SimulationBase< T >::physTimeStabilityCheck {0.1}

Definition at line 61 of file solverParameters.h.

{0.1};

pressureFilter

template<typename T >

bool olb::parameters::SimulationBase< T >::pressureFilter {false}

Definition at line 63 of file solverParameters.h.

{false};

startUpTime

template<typename T >

BT olb::parameters::SimulationBase< T >::startUpTime {0}

Definition at line 58 of file solverParameters.h.

{0};

---

The documentation for this struct was generated from the following file:

• src/solver/solverParameters.h