SnapshotConfiguration Class Reference

Manages snapshot and time-related parameters. More...

#include <SnapshotConfiguration.H>

Public Member Functions
const Foam::fileName &	get_casenameData () const
const Foam::label &	get_startTime () const
const Foam::label &	get_endTime () const
const Foam::label &	get_nSnapshots () const
const Foam::label &	get_endTimeSimulation () const
const Foam::label &	get_nSnapshotsSimulation () const
const double &	get_initialTime () const
const double &	get_finalTime () const
const double &	get_finalTimeSimulation () const
const double &	get_writeInterval () const
const Foam::label &	get_nSimu () const
void	set_casenameData (const Foam::fileName &cn)
void	set_startTime (const Foam::label &st)
void	set_endTime (const Foam::label &et)
void	set_nSnapshots (const Foam::label &ns)
void	set_endTimeSimulation (const Foam::label &ets)
void	set_nSnapshotsSimulation (const Foam::label &nss)
void	set_initialTime (const double &it)
void	set_finalTime (const double &ft)
void	set_finalTimeSimulation (const double &fts)
void	set_writeInterval (const double &wi)
void	set_nSimu (const Foam::label &ns)

Detailed Description

Manages snapshot and time-related parameters.

Definition at line 15 of file SnapshotConfiguration.H.

Constructor & Destructor Documentation

SnapshotConfiguration()

SnapshotConfiguration::SnapshotConfiguration ( )

inline

Definition at line 18 of file SnapshotConfiguration.H.

Member Function Documentation

get_casenameData()

const Foam::fileName & SnapshotConfiguration::get_casenameData ( ) const

inline

Definition at line 24 of file SnapshotConfiguration.H.

get_endTime()

const Foam::label & SnapshotConfiguration::get_endTime ( ) const

inline

Definition at line 27 of file SnapshotConfiguration.H.

get_endTimeSimulation()

const Foam::label & SnapshotConfiguration::get_endTimeSimulation ( ) const

inline

Definition at line 30 of file SnapshotConfiguration.H.

get_finalTime()

const double & SnapshotConfiguration::get_finalTime ( ) const

inline

Definition at line 34 of file SnapshotConfiguration.H.

get_finalTimeSimulation()

const double & SnapshotConfiguration::get_finalTimeSimulation ( ) const

inline

Definition at line 35 of file SnapshotConfiguration.H.

get_initialTime()

const double & SnapshotConfiguration::get_initialTime ( ) const

inline

Definition at line 33 of file SnapshotConfiguration.H.

get_nSimu()

const Foam::label & SnapshotConfiguration::get_nSimu ( ) const

inline

Definition at line 37 of file SnapshotConfiguration.H.

get_nSnapshots()

const Foam::label & SnapshotConfiguration::get_nSnapshots ( ) const

inline

Definition at line 28 of file SnapshotConfiguration.H.

get_nSnapshotsSimulation()

const Foam::label & SnapshotConfiguration::get_nSnapshotsSimulation ( ) const

inline

Definition at line 31 of file SnapshotConfiguration.H.

get_startTime()

const Foam::label & SnapshotConfiguration::get_startTime ( ) const

inline

Definition at line 26 of file SnapshotConfiguration.H.

get_writeInterval()

const double & SnapshotConfiguration::get_writeInterval ( ) const

inline

Definition at line 36 of file SnapshotConfiguration.H.

set_casenameData()

void SnapshotConfiguration::set_casenameData ( const Foam::fileName & cn )

inline

Definition at line 39 of file SnapshotConfiguration.H.

set_endTime()

void SnapshotConfiguration::set_endTime ( const Foam::label & et )

inline

Definition at line 41 of file SnapshotConfiguration.H.

set_endTimeSimulation()

void SnapshotConfiguration::set_endTimeSimulation ( const Foam::label & ets )

inline

Definition at line 43 of file SnapshotConfiguration.H.

set_finalTime()

void SnapshotConfiguration::set_finalTime ( const double & ft )

inline

Definition at line 46 of file SnapshotConfiguration.H.

set_finalTimeSimulation()

void SnapshotConfiguration::set_finalTimeSimulation ( const double & fts )

inline

Definition at line 47 of file SnapshotConfiguration.H.

set_initialTime()

void SnapshotConfiguration::set_initialTime ( const double & it )

inline

Definition at line 45 of file SnapshotConfiguration.H.

set_nSimu()

void SnapshotConfiguration::set_nSimu ( const Foam::label & ns )

inline

Definition at line 49 of file SnapshotConfiguration.H.

set_nSnapshots()

void SnapshotConfiguration::set_nSnapshots ( const Foam::label & ns )

inline

Definition at line 42 of file SnapshotConfiguration.H.

set_nSnapshotsSimulation()

void SnapshotConfiguration::set_nSnapshotsSimulation ( const Foam::label & nss )

inline

Definition at line 44 of file SnapshotConfiguration.H.

set_startTime()

void SnapshotConfiguration::set_startTime ( const Foam::label & st )

inline

Definition at line 40 of file SnapshotConfiguration.H.

set_writeInterval()

void SnapshotConfiguration::set_writeInterval ( const double & wi )

inline

Definition at line 48 of file SnapshotConfiguration.H.

---

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

• /github/workspace/src/ITHACA_CORE/ITHACAstream/SnapshotConfiguration.H