olb::parameters::OutputGeneral< T, LatticeLog > Struct Template Reference

Structs to keep parameters which characterize the output. More...

#include <solverParameters.h>

Inheritance diagram for olb::parameters::OutputGeneral< T, LatticeLog >:

Collaboration diagram for olb::parameters::OutputGeneral< T, LatticeLog >:

Public Types
using	BT = BaseType<T>
using	printLatticeStatistics = meta::list<LatticeLog>

Public Member Functions
	OutputGeneral ()=default
	OutputGeneral (std::string name_, std::string olbDir_, std::string outputDir_, bool verbose_, bool printLogConverter_, BT logT_, int timerPrintMode_)
virtual void	initialize () override

Public Attributes
std::string	name {"unnamed"}
std::string	olbDir {"../../../"}
std::string	outputDir {"./tmp/"}
bool	verbose {true}
bool	printLogConverter {true}
BT	logT
int	timerPrintMode {2}

Detailed Description

template<typename T, typename LatticeLog = names::NavierStokes>
struct olb::parameters::OutputGeneral< T, LatticeLog >

Structs to keep parameters which characterize the output.

So far, bash/ gnuplot/ image/ vtk are supported.

Definition at line 137 of file solverParameters.h.

Member Typedef Documentation

BT

template<typename T , typename LatticeLog = names::NavierStokes>

using olb::parameters::OutputGeneral< T, LatticeLog >::BT = BaseType<T>

Definition at line 139 of file solverParameters.h.

printLatticeStatistics

template<typename T , typename LatticeLog = names::NavierStokes>

using olb::parameters::OutputGeneral< T, LatticeLog >::printLatticeStatistics = meta::list<LatticeLog>

Definition at line 148 of file solverParameters.h.

Constructor & Destructor Documentation

OutputGeneral() [1/2]

template<typename T , typename LatticeLog = names::NavierStokes>

olb::parameters::OutputGeneral< T, LatticeLog >::OutputGeneral ( )

default

OutputGeneral() [2/2]

template<typename T , typename LatticeLog = names::NavierStokes>

olb::parameters::OutputGeneral< T, LatticeLog >::OutputGeneral ( std::string name_, std::string olbDir_, std::string outputDir_, bool verbose_, bool printLogConverter_, BT logT_, int timerPrintMode_ )

inline

Definition at line 154 of file solverParameters.h.

    : name(name_), olbDir(olbDir_), outputDir(outputDir_), verbose(verbose_),
    printLogConverter(printLogConverter_), logT(logT_),
    timerPrintMode(timerPrintMode_)
  { }

Member Function Documentation

initialize()

template<typename T , typename LatticeLog = names::NavierStokes>

virtual void olb::parameters::OutputGeneral< T, LatticeLog >::initialize ( )

inlineoverridevirtual

Reimplemented from olb::parameters::ParameterBase.

Definition at line 171 of file solverParameters.h.

  {
    singleton::directories().setOlbDir(olbDir);
    singleton::directories().setOutputDir(outputDir);
  }

References olb::singleton::directories(), olb::parameters::OutputGeneral< T, LatticeLog >::olbDir, olb::parameters::OutputGeneral< T, LatticeLog >::outputDir, olb::singleton::Directories::setOlbDir(), and olb::singleton::Directories::setOutputDir().

Here is the call graph for this function:

Member Data Documentation

logT

template<typename T , typename LatticeLog = names::NavierStokes>

BT olb::parameters::OutputGeneral< T, LatticeLog >::logT

Definition at line 146 of file solverParameters.h.

name

template<typename T , typename LatticeLog = names::NavierStokes>

std::string olb::parameters::OutputGeneral< T, LatticeLog >::name {"unnamed"}

Definition at line 140 of file solverParameters.h.

{"unnamed"};

olbDir

template<typename T , typename LatticeLog = names::NavierStokes>

std::string olb::parameters::OutputGeneral< T, LatticeLog >::olbDir {"../../../"}

Definition at line 141 of file solverParameters.h.

{"../../../"};

outputDir

template<typename T , typename LatticeLog = names::NavierStokes>

std::string olb::parameters::OutputGeneral< T, LatticeLog >::outputDir {"./tmp/"}

Definition at line 142 of file solverParameters.h.

{"./tmp/"};

printLogConverter

template<typename T , typename LatticeLog = names::NavierStokes>

bool olb::parameters::OutputGeneral< T, LatticeLog >::printLogConverter {true}

Definition at line 145 of file solverParameters.h.

{true};

timerPrintMode

template<typename T , typename LatticeLog = names::NavierStokes>

int olb::parameters::OutputGeneral< T, LatticeLog >::timerPrintMode {2}

Definition at line 150 of file solverParameters.h.

{2};

verbose

template<typename T , typename LatticeLog = names::NavierStokes>

bool olb::parameters::OutputGeneral< T, LatticeLog >::verbose {true}

Definition at line 144 of file solverParameters.h.

{true};

---

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

• src/solver/solverParameters.h