Stores all relevant solution info for cloud. More...

#include <cloudSolution.H>

Public Member Functions
	cloudSolution (const fvMesh &mesh)
	Construct null from mesh reference.
	cloudSolution (const fvMesh &mesh, const dictionary &dict)
	Construct from mesh and dictionary.
	cloudSolution (const cloudSolution &cs)
	Construct copy.
	~cloudSolution ()=default
	Destructor.
void	read ()
	Read properties from dictionary.
scalar	relaxCoeff (const word &fieldName) const
	Return relaxation coefficient for field.
bool	semiImplicit (const word &fieldName) const
	Return semi-implicit flag coefficient for field.
const fvMesh &	mesh () const
	Return reference to the mesh.
const dictionary &	dict () const
	Return const access to the dictionary.
const Switch	active () const
	Return the active flag.
const Switch	transient () const
	Return const access to the transient flag.
const Switch	steadyState () const
	Return const access to the steady flag.
label	calcFrequency () const
	Return const access to the calculation frequency.
scalar	maxCo () const
	Return const access to the max particle Courant number.
label	iter () const
	Return const access to the current cloud iteration.
label	nextIter ()
	Increment and return iter counter.
scalar	trackTime () const
	Return the particle track time.
scalar	deltaTMax () const
	Return the maximum integration time step.
const Switch	coupled () const
	Return const access to the coupled flag.
Switch &	coupled ()
	Return non-const access to the coupled flag.
const Switch	cellValueSourceCorrection () const
	Return const access to the cell value correction flag.
scalar	maxTrackTime () const
	Return const access to the particle track time.
const Switch	resetSourcesOnStartup () const
	Return const access to the reset sources flag.
const dictionary &	sourceTermDict () const
	Source terms dictionary.
const dictionary &	interpolationSchemes () const
	Interpolation schemes dictionary.
const dictionary &	integrationSchemes () const
	Integration schemes dictionary.
bool	solveThisStep () const
	Returns true if performing a cloud iteration this calc step.
bool	canEvolve ()
	Returns true if possible to evolve the cloud and sets timestep parameters.
bool	log () const
	Returns true if possible to log this step.
bool	output () const
	Returns true if writing this step.
scalar	deltaTMax (const scalar trackTime) const
	Return the maximum integration time.
scalar	deltaLMax (const scalar lRef) const
	Return the maximum integration length.

Static Public Attributes
static int	debug
	Debug switch.

Detailed Description

Stores all relevant solution info for cloud.

Source files

Definition at line 49 of file cloudSolution.H.

Constructor & Destructor Documentation

◆ cloudSolution() [1/3]

cloudSolution ( const fvMesh & mesh )

Construct null from mesh reference.

Definition at line 99 of file cloudSolution.C.

References mesh().

Referenced by cloudSolution().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cloudSolution() [2/3]

cloudSolution	(	const fvMesh &	mesh,
		const dictionary &	dict )

Construct from mesh and dictionary.

Definition at line 35 of file cloudSolution.C.

References dict(), Foam::endl(), Foam::Info, mesh(), read(), and dictionary::readIfPresent().

Here is the call graph for this function:

◆ cloudSolution() [3/3]

cloudSolution ( const cloudSolution & cs )

Construct copy.

Definition at line 79 of file cloudSolution.C.

References cloudSolution().

Here is the call graph for this function:

◆ ~cloudSolution()

~cloudSolution ( )

default

Destructor.

References trackTime().

Here is the call graph for this function:

Member Function Documentation

◆ read()

void read ( )

Read properties from dictionary.

Definition at line 121 of file cloudSolution.C.

References localEulerDdt::enabled(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, IOWarningInFunction, dictionary::lookup(), UList< T >::size(), steadyState(), and dictionary::toc().

Referenced by cloudSolution().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ relaxCoeff()

Foam::scalar relaxCoeff ( const word & fieldName ) const

Return relaxation coefficient for field.

Definition at line 204 of file cloudSolution.C.

References debug, Foam::endl(), and WarningInFunction.

Here is the call graph for this function:

◆ semiImplicit()

bool semiImplicit ( const word & fieldName ) const

Return semi-implicit flag coefficient for field.

Definition at line 225 of file cloudSolution.C.

References debug, Foam::endl(), and WarningInFunction.

Here is the call graph for this function:

◆ mesh()

const Foam::fvMesh & mesh ( ) const

inline

Return reference to the mesh.

Definition at line 21 of file cloudSolutionI.H.

Referenced by cloudSolution(), and cloudSolution().

Here is the caller graph for this function:

◆ dict()

const Foam::dictionary & dict ( ) const

inline

Return const access to the dictionary.

Definition at line 27 of file cloudSolutionI.H.

Referenced by cloudSolution().

Here is the caller graph for this function:

◆ active()

const Foam::Switch active ( ) const

inline

Return the active flag.

Definition at line 33 of file cloudSolutionI.H.

◆ transient()

const Foam::Switch transient ( ) const

inline

Return const access to the transient flag.

Definition at line 57 of file cloudSolutionI.H.

◆ steadyState()

const Foam::Switch steadyState ( ) const

inline

Return const access to the steady flag.

Definition at line 63 of file cloudSolutionI.H.

Referenced by read().

Here is the caller graph for this function:

◆ calcFrequency()

Foam::label calcFrequency ( ) const

inline

Return const access to the calculation frequency.

Definition at line 69 of file cloudSolutionI.H.

◆ maxCo()

Foam::scalar maxCo ( ) const

inline

Return const access to the max particle Courant number.

Definition at line 75 of file cloudSolutionI.H.

◆ iter()

Foam::label iter ( ) const

inline

Return const access to the current cloud iteration.

Definition at line 81 of file cloudSolutionI.H.

◆ nextIter()

Foam::label nextIter ( )

inline

Increment and return iter counter.

Definition at line 87 of file cloudSolutionI.H.

◆ trackTime()

Foam::scalar trackTime ( ) const

inline

Return the particle track time.

Definition at line 93 of file cloudSolutionI.H.

Referenced by deltaTMax(), and ~cloudSolution().

Here is the caller graph for this function:

◆ deltaTMax() [1/2]

Foam::scalar deltaTMax ( ) const

inline

Return the maximum integration time step.

Definition at line 99 of file cloudSolutionI.H.

◆ coupled() [1/2]

const Foam::Switch coupled ( ) const

inline

Return const access to the coupled flag.

Definition at line 111 of file cloudSolutionI.H.

◆ coupled() [2/2]

Foam::Switch & coupled ( )

inline

Return non-const access to the coupled flag.

Definition at line 105 of file cloudSolutionI.H.

◆ cellValueSourceCorrection()

const Foam::Switch cellValueSourceCorrection ( ) const

inline

Return const access to the cell value correction flag.

Definition at line 117 of file cloudSolutionI.H.

◆ maxTrackTime()

Foam::scalar maxTrackTime ( ) const

inline

Return const access to the particle track time.

Definition at line 123 of file cloudSolutionI.H.

◆ resetSourcesOnStartup()

const Foam::Switch resetSourcesOnStartup ( ) const

inline

Return const access to the reset sources flag.

Definition at line 129 of file cloudSolutionI.H.

◆ sourceTermDict()

const Foam::dictionary & sourceTermDict ( ) const

inline

Source terms dictionary.

Definition at line 39 of file cloudSolutionI.H.

References dictionary::subDict().

Here is the call graph for this function:

◆ interpolationSchemes()

const Foam::dictionary & interpolationSchemes ( ) const

inline

Interpolation schemes dictionary.

Definition at line 45 of file cloudSolutionI.H.

References dictionary::subDict().

Here is the call graph for this function:

◆ integrationSchemes()

const Foam::dictionary & integrationSchemes ( ) const

inline

Integration schemes dictionary.

Definition at line 51 of file cloudSolutionI.H.

References dictionary::subDict().

Here is the call graph for this function:

◆ solveThisStep()

bool solveThisStep ( ) const

Returns true if performing a cloud iteration this calc step.

Definition at line 246 of file cloudSolution.C.

Referenced by canEvolve().

Here is the caller graph for this function:

◆ canEvolve()

bool canEvolve ( )

Returns true if possible to evolve the cloud and sets timestep parameters.

Definition at line 257 of file cloudSolution.C.

References solveThisStep().

Here is the call graph for this function:

◆ log()

bool log ( ) const

Returns true if possible to log this step.

Definition at line 272 of file cloudSolution.C.

◆ output()

bool output ( ) const

Returns true if writing this step.

Definition at line 281 of file cloudSolution.C.

◆ deltaTMax() [2/2]

Foam::scalar deltaTMax ( const scalar trackTime ) const

Return the maximum integration time.

Definition at line 287 of file cloudSolution.C.

References Foam::min(), and trackTime().

Here is the call graph for this function:

◆ deltaLMax()

Foam::scalar deltaLMax ( const scalar lRef ) const

Return the maximum integration length.

Definition at line 300 of file cloudSolution.C.

Member Data Documentation

◆ debug

int debug

static

Debug switch.

Definition at line 159 of file cloudSolution.H.

Referenced by relaxCoeff(), and semiImplicit().

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

src/lagrangian/intermediate/clouds/Templates/KinematicCloud/cloudSolution/cloudSolution.H
src/lagrangian/intermediate/clouds/Templates/KinematicCloud/cloudSolution/cloudSolution.C
src/lagrangian/intermediate/clouds/Templates/KinematicCloud/cloudSolution/cloudSolutionI.H

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ cloudSolution() [1/3]

◆ cloudSolution() [2/3]

◆ cloudSolution() [3/3]

◆ ~cloudSolution()

Member Function Documentation

◆ read()

◆ relaxCoeff()

◆ semiImplicit()

◆ mesh()

◆ dict()

◆ active()

◆ transient()

◆ steadyState()

◆ calcFrequency()

◆ maxCo()

◆ iter()

◆ nextIter()

◆ trackTime()

◆ deltaTMax() [1/2]

◆ coupled() [1/2]

◆ coupled() [2/2]

◆ cellValueSourceCorrection()

◆ maxTrackTime()

◆ resetSourcesOnStartup()

◆ sourceTermDict()

◆ interpolationSchemes()

◆ integrationSchemes()

◆ solveThisStep()

◆ canEvolve()

◆ log()

◆ output()

◆ deltaTMax() [2/2]

◆ deltaLMax()

Member Data Documentation

◆ debug