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... | |
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... | |
Stores all relevant solution info for cloud.
Definition at line 51 of file cloudSolution.H.
cloudSolution | ( | const fvMesh & | mesh | ) |
Construct null from mesh reference.
Definition at line 80 of file cloudSolution.C.
Referenced by cloudSolution::cloudSolution().
cloudSolution | ( | const fvMesh & | mesh, |
const dictionary & | dict | ||
) |
Construct from mesh and dictionary.
Definition at line 32 of file cloudSolution.C.
References cloudSolution::cloudSolution(), and Foam::blockMeshTools::read().
cloudSolution | ( | const cloudSolution & | cs | ) |
Construct copy.
Definition at line 59 of file cloudSolution.C.
References cloudSolution::cloudSolution().
|
virtual |
Destructor.
Definition at line 102 of file cloudSolution.C.
void read | ( | ) |
Read properties from dictionary.
Definition at line 108 of file cloudSolution.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, dictionary::lookup(), dictionary::readIfPresent(), Foam::fvc::scheme(), cloudSolution::steadyState(), and dictionary::subDict().
Foam::scalar relaxCoeff | ( | const word & | fieldName | ) | const |
Return relaxation coefficient for field.
Definition at line 164 of file cloudSolution.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and forAll.
bool semiImplicit | ( | const word & | fieldName | ) | const |
Return semi-implicit flag coefficient for field.
Definition at line 182 of file cloudSolution.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and forAll.
|
inline |
Return reference to the mesh.
Definition at line 26 of file cloudSolutionI.H.
|
inline |
Return const access to the dictionary.
Definition at line 32 of file cloudSolutionI.H.
|
inline |
Return the active flag.
Definition at line 38 of file cloudSolutionI.H.
|
inline |
Return const access to the transient flag.
Definition at line 62 of file cloudSolutionI.H.
|
inline |
Return const access to the steady flag.
Definition at line 68 of file cloudSolutionI.H.
Referenced by cloudSolution::read().
|
inline |
Return const access to the calculation frequency.
Definition at line 74 of file cloudSolutionI.H.
|
inline |
Return const access to the max particle Courant number.
Definition at line 80 of file cloudSolutionI.H.
|
inline |
Return const access to the current cloud iteration.
Definition at line 86 of file cloudSolutionI.H.
|
inline |
Increment and return iter counter.
Definition at line 92 of file cloudSolutionI.H.
|
inline |
Return the particle track time.
Definition at line 98 of file cloudSolutionI.H.
|
inline |
Return const access to the coupled flag.
Definition at line 110 of file cloudSolutionI.H.
|
inline |
Return non-const access to the coupled flag.
Definition at line 104 of file cloudSolutionI.H.
|
inline |
Return const access to the cell value correction flag.
Definition at line 116 of file cloudSolutionI.H.
|
inline |
Return const access to the particle track time.
Definition at line 122 of file cloudSolutionI.H.
|
inline |
Return const access to the reset sources flag.
Definition at line 128 of file cloudSolutionI.H.
|
inline |
Source terms dictionary.
Definition at line 44 of file cloudSolutionI.H.
References dictionary::subDict().
|
inline |
Interpolation schemes dictionary.
Definition at line 50 of file cloudSolutionI.H.
References dictionary::subDict().
|
inline |
Integration schemes dictionary.
Definition at line 56 of file cloudSolutionI.H.
References dictionary::subDict().
bool solveThisStep | ( | ) | const |
Returns true if performing a cloud iteration this calc step.
Definition at line 200 of file cloudSolution.C.
References fvMesh::time(), TimeState::timeIndex(), and TimeState::writeTime().
Referenced by cloudSolution::canEvolve().
bool canEvolve | ( | ) |
Returns true if possible to evolve the cloud and sets timestep.
parameters
Definition at line 211 of file cloudSolution.C.
References TimeState::deltaTValue(), cloudSolution::solveThisStep(), and fvMesh::time().
bool output | ( | ) | const |
Returns true if writing this step.
Definition at line 226 of file cloudSolution.C.
References fvMesh::time(), and TimeState::writeTime().