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

Collaboration diagram for cloudSolution:

[legend]

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 integation 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...

Private Member Functions
void	operator= (const cloudSolution &)
	Disallow default bitwise assignment. More...

Private Attributes
const fvMesh &	mesh_
	Reference to the mesh. More...

dictionary	dict_
	Dictionary used during construction. More...

const Switch	active_
	Cloud active flag. More...

Switch	transient_
	Transient flag. More...

label	calcFrequency_
	Calculation frequency - carrier steps per cloud step. More...

scalar	maxCo_
	Maximum particle Courant number. More...

label	iter_
	Current cloud iteration. More...

scalar	trackTime_
	Particle track time. More...

scalar	deltaTMax_
	Maximum integration time step (optional) More...

Switch	coupled_
	Flag to indicate whether parcels are coupled to the carrier. More...

Switch	cellValueSourceCorrection_
	Flag to correct cell values with latest transfer information. More...

scalar	maxTrackTime_
	Maximum particle track time [s]. More...

Switch	resetSourcesOnStartup_
	Flag to indicate whether coupling source terms should be. More...

List< Tuple2< word, Tuple2< bool, scalar > > >	schemes_
	List schemes, e.g. U semiImplicit 1. More...

Detailed Description

Stores all relevant solution info for cloud.

Source files

Definition at line 51 of file cloudSolution.H.

Constructor & Destructor Documentation

◆ cloudSolution() [1/3]

cloudSolution ( const fvMesh & mesh )

Construct null from mesh reference.

Definition at line 89 of file cloudSolution.C.

◆ cloudSolution() [2/3]

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

Construct from mesh and dictionary.

Definition at line 31 of file cloudSolution.C.

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

Here is the call graph for this function:

◆ cloudSolution() [3/3]

cloudSolution ( const cloudSolution & cs )

Construct copy.

Definition at line 70 of file cloudSolution.C.

◆ ~cloudSolution()

~cloudSolution ( )

virtual

Destructor.

Definition at line 110 of file cloudSolution.C.

Member Function Documentation

◆ operator=()

void operator= ( const cloudSolution & )

private

Disallow default bitwise assignment.

◆ read()

void read ( )

Read properties from dictionary.

Definition at line 116 of file cloudSolution.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, dictionary::lookup(), Foam::fvc::scheme(), List::size(), and dictionary::toc().

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 173 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 191 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 26 of file cloudSolutionI.H.

References cloudSolution::mesh_.

◆ dict()

const Foam::dictionary & dict ( ) const

inline

Return const access to the dictionary.

Definition at line 32 of file cloudSolutionI.H.

◆ active()

const Foam::Switch active ( ) const

inline

Return the active flag.

Definition at line 38 of file cloudSolutionI.H.

◆ transient()

const Foam::Switch transient ( ) const

inline

Return const access to the transient flag.

Definition at line 62 of file cloudSolutionI.H.

◆ steadyState()

const Foam::Switch steadyState ( ) const

inline

Return const access to the steady flag.

Definition at line 68 of file cloudSolutionI.H.

◆ calcFrequency()

Foam::label calcFrequency ( ) const

inline

Return const access to the calculation frequency.

Definition at line 74 of file cloudSolutionI.H.

◆ maxCo()

Foam::scalar maxCo ( ) const

inline

Return const access to the max particle Courant number.

Definition at line 80 of file cloudSolutionI.H.

◆ iter()

Foam::label iter ( ) const

inline

Return const access to the current cloud iteration.

Definition at line 86 of file cloudSolutionI.H.

◆ nextIter()

Foam::label nextIter ( )

inline

Increment and return iter counter.

Definition at line 92 of file cloudSolutionI.H.

◆ trackTime()

Foam::scalar trackTime ( ) const

inline

Return the particle track time.

Definition at line 98 of file cloudSolutionI.H.

◆ deltaTMax() [1/2]

Foam::scalar deltaTMax ( ) const

inline

Return the maximum integation time step.

Definition at line 104 of file cloudSolutionI.H.

◆ coupled() [1/2]

const Foam::Switch coupled ( ) const

inline

Return const access to the coupled flag.

Definition at line 110 of file cloudSolutionI.H.

◆ coupled() [2/2]

Switch& coupled ( )

inline

Return non-const access to the coupled flag.

◆ cellValueSourceCorrection()

const Foam::Switch cellValueSourceCorrection ( ) const

inline

Return const access to the cell value correction flag.

Definition at line 122 of file cloudSolutionI.H.

◆ maxTrackTime()

Foam::scalar maxTrackTime ( ) const

inline

Return const access to the particle track time.

Definition at line 128 of file cloudSolutionI.H.

◆ resetSourcesOnStartup()

const Foam::Switch resetSourcesOnStartup ( ) const

inline

Return const access to the reset sources flag.

Definition at line 134 of file cloudSolutionI.H.

◆ sourceTermDict()

const Foam::dictionary & sourceTermDict ( ) const

inline

Source terms dictionary.

Definition at line 44 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 50 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 56 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 209 of file cloudSolution.C.

◆ canEvolve()

bool canEvolve ( )

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

parameters

Definition at line 220 of file cloudSolution.C.

◆ output()

bool output ( ) const

Returns true if writing this step.

Definition at line 235 of file cloudSolution.C.

◆ deltaTMax() [2/2]

Foam::scalar deltaTMax ( const scalar trackTime ) const

Return the maximum integration time.

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

Field Documentation

◆ mesh_

const fvMesh& mesh_

private

Reference to the mesh.

Definition at line 56 of file cloudSolution.H.

Referenced by cloudSolution::mesh().

◆ dict_

dictionary dict_

private

Dictionary used during construction.

Definition at line 59 of file cloudSolution.H.

Referenced by cloudSolution::cloudSolution().

◆ active_

const Switch active_

private

Cloud active flag.

Definition at line 62 of file cloudSolution.H.

Referenced by cloudSolution::cloudSolution().

◆ transient_

Switch transient_

private

Transient flag.

Definition at line 65 of file cloudSolution.H.

◆ calcFrequency_

label calcFrequency_

private

Calculation frequency - carrier steps per cloud step.

NOTE: Steady operation only

Definition at line 69 of file cloudSolution.H.

◆ maxCo_

scalar maxCo_

private

Maximum particle Courant number.

Max fraction of current cell that can be traversed in a single step

Definition at line 74 of file cloudSolution.H.

◆ iter_

label iter_

private

Current cloud iteration.

Definition at line 77 of file cloudSolution.H.

◆ trackTime_

scalar trackTime_

private

Particle track time.

Definition at line 80 of file cloudSolution.H.

◆ deltaTMax_

scalar deltaTMax_

private

Maximum integration time step (optional)

Definition at line 83 of file cloudSolution.H.

◆ coupled_

Switch coupled_

private

Flag to indicate whether parcels are coupled to the carrier.

phase, i.e. whether or not to generate source terms for carrier phase

Definition at line 91 of file cloudSolution.H.

◆ cellValueSourceCorrection_

Switch cellValueSourceCorrection_

private

Flag to correct cell values with latest transfer information.

during the lagrangian timestep

Definition at line 95 of file cloudSolution.H.

◆ maxTrackTime_

scalar maxTrackTime_

private

Maximum particle track time [s].

Definition at line 98 of file cloudSolution.H.

◆ resetSourcesOnStartup_

Switch resetSourcesOnStartup_

private

Flag to indicate whether coupling source terms should be.

reset on start-up/first read

Definition at line 102 of file cloudSolution.H.

Referenced by cloudSolution::cloudSolution().

◆ schemes_

List<Tuple2<word, Tuple2<bool, scalar> > > schemes_

private

List schemes, e.g. U semiImplicit 1.

Definition at line 105 of file cloudSolution.H.

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

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ cloudSolution() [1/3]

◆ cloudSolution() [2/3]

◆ cloudSolution() [3/3]

◆ ~cloudSolution()

Member Function Documentation

◆ operator=()

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

Field Documentation

◆ mesh_

◆ dict_

◆ active_

◆ transient_

◆ calcFrequency_

◆ maxCo_

◆ iter_

◆ trackTime_

◆ deltaTMax_

◆ coupled_

◆ cellValueSourceCorrection_

◆ maxTrackTime_

◆ resetSourcesOnStartup_

◆ schemes_