ITHACAparameters Class Reference

Class for the definition of some general parameters, the parameters must be defined from the file ITHACAdict inside the system folder. More...

#include <ITHACAparameters.H>

Public Member Functions
	ITHACAparameters (fvMesh &mesh, Time &localTime)
	~ITHACAparameters ()=delete
	Delete empty constructor.

Static Public Member Functions
static ITHACAparameters *	getInstance (fvMesh &mesh, Time &localTime)
	Gets an instance of ITHACAparameters, to be used if the instance is not existing.
static ITHACAparameters *	getInstance ()
	Gets an instance of ITHACAparameters, to be used if the instance is already existing.

Public Attributes
word	eigensolver
	type of eigensolver used in the eigenvalue decomposition can be either be eigen or spectra
label	precision
	precision of the output Market Matrix objects (i.e. reduced matrices, eigenvalues, ...)
bool	exportPython
bool	exportMatlab
bool	exportTxt
bool	exportNpy
bool	debug
bool	warnings
bool	correctBC
std::_Ios_Fmtflags	outytpe
	type of output format can be fixed or scientific
IOdictionary *	ITHACAdict
	Dictionary for input objects from file.
Time &	runTime
	runTime defined locally
fvMesh &	mesh
	Mesh object defined locally.

Static Public Attributes
static ITHACAparameters *	instance = nullptr
	Pointer to the ITHACAparameters class.

Detailed Description

Class for the definition of some general parameters, the parameters must be defined from the file ITHACAdict inside the system folder.

Examples

02enKF_1DinverseHeatTransfer.C, 02thermalBlock.C, 03steadyNS.C, 04unsteadyNS.C, 06POD_RBF.C, 08DEIM.C, 09DEIM_ROM.C, 10UnsteadyBBEnclosed.C, 11UnsteadyBBOpen.C, 17YJunction.C, 19UnsteadyNSExplicit.C, 20incrementalPOD.C, and IHTP01inverseLaplacian.C.

Definition at line 40 of file ITHACAparameters.H.

Constructor & Destructor Documentation

ITHACAparameters()

ITHACAparameters::ITHACAparameters	(	fvMesh &	mesh,
		Time &	localTime )

Definition at line 5 of file ITHACAparameters.C.

~ITHACAparameters()

ITHACAparameters::~ITHACAparameters ( )

delete

Delete empty constructor.

Member Function Documentation

getInstance() [1/2]

ITHACAparameters * ITHACAparameters::getInstance ( )

static

Gets an instance of ITHACAparameters, to be used if the instance is already existing.

Returns

The instance.

Examples

02enKF_1DinverseHeatTransfer.C, 02thermalBlock.C, 03steadyNS.C, 04unsteadyNS.C, 06POD_RBF.C, 08DEIM.C, 09DEIM_ROM.C, 10UnsteadyBBEnclosed.C, 11UnsteadyBBOpen.C, 17YJunction.C, 19UnsteadyNSExplicit.C, 20incrementalPOD.C, and IHTP01inverseLaplacian.C.

Definition at line 56 of file ITHACAparameters.C.

getInstance() [2/2]

ITHACAparameters * ITHACAparameters::getInstance ( fvMesh & mesh, Time & localTime )

static

Gets an instance of ITHACAparameters, to be used if the instance is not existing.

Parameters

mesh	The mesh
localTime	The runtime object

Returns

The instance.

Definition at line 45 of file ITHACAparameters.C.

Member Data Documentation

correctBC

bool ITHACAparameters::correctBC

Definition at line 59 of file ITHACAparameters.H.

debug

bool ITHACAparameters::debug

Definition at line 57 of file ITHACAparameters.H.

eigensolver

word ITHACAparameters::eigensolver

type of eigensolver used in the eigenvalue decomposition can be either be eigen or spectra

Definition at line 47 of file ITHACAparameters.H.

exportMatlab

bool ITHACAparameters::exportMatlab

Definition at line 54 of file ITHACAparameters.H.

exportNpy

bool ITHACAparameters::exportNpy

Definition at line 56 of file ITHACAparameters.H.

exportPython

bool ITHACAparameters::exportPython

Definition at line 53 of file ITHACAparameters.H.

exportTxt

bool ITHACAparameters::exportTxt

Definition at line 55 of file ITHACAparameters.H.

instance

ITHACAparameters * ITHACAparameters::instance = nullptr

static

Pointer to the ITHACAparameters class.

Definition at line 74 of file ITHACAparameters.H.

ITHACAdict

IOdictionary* ITHACAparameters::ITHACAdict

Dictionary for input objects from file.

Definition at line 65 of file ITHACAparameters.H.

mesh

fvMesh& ITHACAparameters::mesh

Mesh object defined locally.

Definition at line 71 of file ITHACAparameters.H.

outytpe

std::_Ios_Fmtflags ITHACAparameters::outytpe

type of output format can be fixed or scientific

Definition at line 62 of file ITHACAparameters.H.

precision

label ITHACAparameters::precision

precision of the output Market Matrix objects (i.e. reduced matrices, eigenvalues, ...)

Definition at line 50 of file ITHACAparameters.H.

runTime

Time& ITHACAparameters::runTime

runTime defined locally

Definition at line 68 of file ITHACAparameters.H.

warnings

bool ITHACAparameters::warnings

Definition at line 58 of file ITHACAparameters.H.

---

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

• /github/workspace/src/ITHACA_CORE/ITHACAstream/ITHACAparameters.H
• /github/workspace/src/ITHACA_CORE/ITHACAstream/ITHACAparameters.C