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

Public Member Functions
	cloudSolution (const fvMesh &mesh)
	Construct null from mesh reference. More...

	cloudSolution (const fvMesh &mesh, const dictionary &dict)
	Construct from mesh and dictionary. More...

	cloudSolution (const cloudSolution &cs)
	Construct copy. More...

virtual	~cloudSolution ()
	Destructor. More...

void	read ()
	Read properties from dictionary. More...

scalar	relaxCoeff (const word &fieldName) const
	Return relaxation coefficient for field. More...

bool	semiImplicit (const word &fieldName) const
	Return semi-implicit flag coefficient for field. More...

const fvMesh &	mesh () const
	Return reference to the mesh. More...

const dictionary &	dict () const
	Return const access to the dictionary. More...

const Switch	active () const
	Return the active flag. More...

const Switch	transient () const
	Return const access to the transient flag. More...

const Switch	steadyState () const
	Return const access to the steady flag. More...

label	calcFrequency () const
	Return const access to the calculation frequency. More...

scalar	maxCo () const
	Return const access to the max particle Courant number. More...

label	iter () const
	Return const access to the current cloud iteration. More...

label	nextIter ()
	Increment and return iter counter. More...

scalar	trackTime () const
	Return the particle track time. More...

scalar	deltaTMax () const
	Return the maximum integration time step. More...

const Switch	coupled () const
	Return const access to the coupled flag. More...

Switch &	coupled ()
	Return non-const access to the coupled flag. More...

const Switch	cellValueSourceCorrection () const
	Return const access to the cell value correction flag. More...

scalar	maxTrackTime () const
	Return const access to the particle track time. More...

const Switch	resetSourcesOnStartup () const
	Return const access to the reset sources flag. More...

const dictionary &	sourceTermDict () const
	Source terms dictionary. More...

const dictionary &	interpolationSchemes () const
	Interpolation schemes dictionary. More...

const dictionary &	integrationSchemes () const
	Integration schemes dictionary. More...

bool	solveThisStep () const
	Returns true if performing a cloud iteration this calc step. More...

bool	canEvolve ()
	Returns true if possible to evolve the cloud and sets timestep. More...

bool	output () const
	Returns true if writing this step. More...

scalar	deltaTMax (const scalar trackTime) const
	Return the maximum integration time. More...

scalar	deltaLMax (const scalar lRef) const
	Return the maximum integration length. More...

Detailed Description

Stores all relevant solution info for cloud.

Source files

Definition at line 53 of file cloudSolution.H.

Constructor & Destructor Documentation

◆ cloudSolution() [1/3]

cloudSolution ( const fvMesh & mesh )

Construct null from mesh reference.

Definition at line 97 of file cloudSolution.C.

◆ cloudSolution() [2/3]

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

Construct from mesh and dictionary.

Definition at line 35 of file cloudSolution.C.

References Foam::endl(), Foam::Info, cloudSolution::read(), dictionary::readIfPresent(), and dictionary::subOrEmptyDict().

Here is the call graph for this function:

◆ cloudSolution() [3/3]

cloudSolution ( const cloudSolution & cs )

Construct copy.

Definition at line 78 of file cloudSolution.C.

◆ ~cloudSolution()

~cloudSolution ( )

virtual

Destructor.

Definition at line 118 of file cloudSolution.C.

Member Function Documentation

◆ read()

void read ( )

Read properties from dictionary.

Definition at line 124 of file cloudSolution.C.

References localEulerDdt::enabled(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, IOWarningInFunction, Foam::fac::scheme(), and List< T >::setSize().

Referenced by cloudSolution::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 205 of file cloudSolution.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and forAll.

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 223 of file cloudSolution.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and forAll.

Here is the call graph for this function:

◆ mesh()

const Foam::fvMesh & mesh ( ) const

inline

Return reference to the mesh.

Definition at line 28 of file cloudSolutionI.H.

◆ dict()

const Foam::dictionary & dict ( ) const

inline

Return const access to the dictionary.

Definition at line 34 of file cloudSolutionI.H.

◆ active()

const Foam::Switch active ( ) const

inline

Return the active flag.

Definition at line 40 of file cloudSolutionI.H.

◆ transient()

const Foam::Switch transient ( ) const

inline

Return const access to the transient flag.

Definition at line 64 of file cloudSolutionI.H.

◆ steadyState()

const Foam::Switch steadyState ( ) const

inline

Return const access to the steady flag.

Definition at line 70 of file cloudSolutionI.H.

◆ calcFrequency()

Foam::label calcFrequency ( ) const

inline

Return const access to the calculation frequency.

Definition at line 76 of file cloudSolutionI.H.

◆ maxCo()

Foam::scalar maxCo ( ) const

inline

Return const access to the max particle Courant number.

Definition at line 82 of file cloudSolutionI.H.

◆ iter()

Foam::label iter ( ) const

inline

Return const access to the current cloud iteration.

Definition at line 88 of file cloudSolutionI.H.

◆ nextIter()

Foam::label nextIter ( )

inline

Increment and return iter counter.

Definition at line 94 of file cloudSolutionI.H.

◆ trackTime()

Foam::scalar trackTime ( ) const

inline

Return the particle track time.

Definition at line 100 of file cloudSolutionI.H.

◆ deltaTMax() [1/2]

Foam::scalar deltaTMax ( ) const

inline

Return the maximum integration time step.

Definition at line 106 of file cloudSolutionI.H.

◆ coupled() [1/2]

const Foam::Switch coupled ( ) const

inline

Return const access to the coupled flag.

Definition at line 118 of file cloudSolutionI.H.

◆ coupled() [2/2]

Foam::Switch & coupled ( )

inline

Return non-const access to the coupled flag.

Definition at line 112 of file cloudSolutionI.H.

◆ cellValueSourceCorrection()

const Foam::Switch cellValueSourceCorrection ( ) const

inline

Return const access to the cell value correction flag.

Definition at line 124 of file cloudSolutionI.H.

◆ maxTrackTime()

Foam::scalar maxTrackTime ( ) const

inline

Return const access to the particle track time.

Definition at line 130 of file cloudSolutionI.H.

◆ resetSourcesOnStartup()

const Foam::Switch resetSourcesOnStartup ( ) const

inline

Return const access to the reset sources flag.

Definition at line 136 of file cloudSolutionI.H.

◆ sourceTermDict()

const Foam::dictionary & sourceTermDict ( ) const

inline

Source terms dictionary.

Definition at line 46 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 52 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 58 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 241 of file cloudSolution.C.

◆ canEvolve()

bool canEvolve ( )

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

parameters

Definition at line 252 of file cloudSolution.C.

◆ output()

bool output ( ) const

Returns true if writing this step.

Definition at line 267 of file cloudSolution.C.

◆ deltaTMax() [2/2]

Foam::scalar deltaTMax ( const scalar trackTime ) const

Return the maximum integration time.

Definition at line 273 of file cloudSolution.C.

References Foam::min().

Here is the call graph for this function:

◆ deltaLMax()

Foam::scalar deltaLMax ( const scalar lRef ) const

Return the maximum integration length.

Definition at line 286 of file cloudSolution.C.

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

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()

◆ output()

◆ deltaTMax() [2/2]

◆ deltaLMax()