This fvModel adds any number of Lagrangian clouds to any single-phase solver. The particles are tracked through, and exchange sources with, the Eulerian flow field. More...
Public Member Functions | |
TypeName ("clouds") | |
Runtime type information. More... | |
clouds (const word &sourceName, const word &modelType, const dictionary &dict, const fvMesh &mesh) | |
Construct from explicit source name and mesh. More... | |
clouds (const clouds &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual wordList | addSupFields () const |
Return the list of fields for which the option adds source term. More... | |
virtual void | correct () |
Solve the Lagrangian clouds and update the sources. More... | |
virtual void | addSup (fvMatrix< scalar > &eqn, const word &fieldName) const |
Add source to continuity equation. More... | |
virtual void | addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const word &fieldName) const |
Add source to enthalpy or species equation. More... | |
virtual void | addSup (fvMatrix< vector > &eqn, const word &fieldName) const |
Add source to incompressible momentum equation. More... | |
virtual void | addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const word &fieldName) const |
Add source to compressible momentum equation. More... | |
virtual void | preUpdateMesh () |
Prepare for mesh update. More... | |
virtual void | topoChange (const polyTopoChangeMap &) |
Update topology using the given map. More... | |
virtual void | mapMesh (const polyMeshMap &) |
Update from another mesh using the given map. More... | |
virtual void | distribute (const polyDistributionMap &) |
Redistribute or update using the given distribution map. More... | |
virtual bool | movePoints () |
Update for mesh motion. More... | |
void | operator= (const clouds &)=delete |
Disallow default bitwise assignment. More... | |
Public Member Functions inherited from fvModel | |
TypeName ("fvModel") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, fvModel, dictionary,(const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh),(name, modelType, dict, mesh)) | |
fvModel (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh) | |
Construct from components. More... | |
autoPtr< fvModel > | clone () const |
Return clone. More... | |
virtual | ~fvModel () |
Destructor. More... | |
const word & | name () const |
Return const access to the source name. More... | |
const fvMesh & | mesh () const |
Return const access to the mesh database. More... | |
const dictionary & | coeffs () const |
Return dictionary. More... | |
virtual bool | addsSupToField (const word &fieldName) const |
Return true if the fvModel adds a source term to the given. More... | |
virtual scalar | maxDeltaT () const |
Return the maximum time-step for stable operation. More... | |
FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_SUP) | |
Add a source term to an equation. More... | |
FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_RHO_SUP) | |
Add a source term to a compressible equation. More... | |
FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_ALPHA_RHO_SUP) | |
Add a source term to a phase equation. More... | |
template<class Type > | |
tmp< fvMatrix< Type > > | source (const GeometricField< Type, fvPatchField, volMesh > &field) const |
Return source for an equation. More... | |
template<class Type > | |
tmp< fvMatrix< Type > > | source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const |
Return source for an equation with a specified name. More... | |
template<class Type > | |
tmp< fvMatrix< Type > > | source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const |
Return source for a compressible equation. More... | |
template<class Type > | |
tmp< fvMatrix< Type > > | source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const |
Return source for a compressible equation with a specified name. More... | |
template<class Type > | |
tmp< fvMatrix< Type > > | source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const |
Return source for a phase equation. More... | |
template<class Type > | |
tmp< fvMatrix< Type > > | source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const |
Return source for a phase equation with a specified name. More... | |
virtual bool | read (const dictionary &dict) |
Read source dictionary. More... | |
template<class Type , class AlphaRhoFieldType , class ... AlphaRhoFieldTypes> | |
Foam::dimensionSet | sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds, const AlphaRhoFieldType &alphaRho, const AlphaRhoFieldTypes &... alphaRhos) |
template<class Type > | |
Foam::dimensionSet | sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds) |
template<class Type , class ... AlphaRhoFieldTypes> | |
Foam::tmp< Foam::fvMatrix< Type > > | source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhos) const |
template<class Type > | |
Foam::tmp< Foam::fvMatrix< Type > > | source (const GeometricField< Type, fvPatchField, volMesh > &field) const |
template<class Type > | |
Foam::tmp< Foam::fvMatrix< Type > > | source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const |
template<class Type > | |
Foam::tmp< Foam::fvMatrix< Type > > | source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const |
template<class Type > | |
Foam::tmp< Foam::fvMatrix< Type > > | source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const |
template<class Type > | |
Foam::tmp< Foam::fvMatrix< Type > > | source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const |
template<class Type > | |
Foam::tmp< Foam::fvMatrix< Type > > | source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const |
Additional Inherited Members | |
Static Public Member Functions inherited from fvModel | |
template<class Type , class AlphaRhoFieldType , class ... AlphaRhoFieldTypes> | |
static dimensionSet | sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds, const AlphaRhoFieldType &alphaRho, const AlphaRhoFieldTypes &... alphaRhos) |
Return the dimensions of the matrix of a source term. More... | |
template<class Type > | |
static dimensionSet | sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds) |
Return the dimensions of the matrix of a source term (base. More... | |
static autoPtr< fvModel > | New (const word &name, const dictionary &dict, const fvMesh &mesh) |
Return a reference to the selected fvModel. More... | |
Protected Member Functions inherited from fvModel | |
template<class Type > | |
void | addSupType (fvMatrix< Type > &eqn, const word &fieldName) const |
Add a source term to an equation. More... | |
template<class Type > | |
void | addSupType (const volScalarField &rho, fvMatrix< Type > &eqn, const word &fieldName) const |
Add a source term to a compressible equation. More... | |
template<class Type > | |
void | addSupType (const volScalarField &alpha, const volScalarField &rho, fvMatrix< Type > &eqn, const word &fieldName) const |
Add a source term to a phase equation. More... | |
template<class Type , class ... AlphaRhoFieldTypes> | |
tmp< fvMatrix< Type > > | source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhos) const |
Return source for equation with specified name and dimensions. More... | |
This fvModel adds any number of Lagrangian clouds to any single-phase solver. The particles are tracked through, and exchange sources with, the Eulerian flow field.
As well as the fvModel controls, properties must be specified for each cloud. For a single cloud, these should be provided in the constant/cloudProperties file. For multiple clouds, the list of cloud names must first be provided in the constant/clouds file. Then, each named cloud has its properties specified in its constant/<cloudName>Properties file.
The application of sources to the Eulerian fields is controlled by the solution/coupled switch in each cloud's properties file. If set to "true" then the Eulerian phase will have forces, and heat and mass sources applied to it by the Lagrangian phase. If set to "false" then these will be omitted, and the Lagrangian phase will not affect the Eulerian phase.
If this model is used with an incompressible solver, then the density of the Eulerian phase must be specified in the constant/physicalProperties dictionary.
Gravity will be read from the constant/g file if present, otherwise it will default to zero.
clouds { libs ("liblagrangianParcel.so"); type clouds; }
Property | Description | Required | Default value |
---|---|---|---|
type | Type name: clouds | yes | |
rho | Name of the density field | no | rho |
U | Name of the velocity field | no | U |
clouds | ( | const word & | sourceName, |
const word & | modelType, | ||
const dictionary & | dict, | ||
const fvMesh & | mesh | ||
) |
TypeName | ( | "clouds" | ) |
Runtime type information.
|
virtual |
Return the list of fields for which the option adds source term.
to the transport equation
Reimplemented from fvModel.
Definition at line 148 of file clouds.C.
References List< T >::append(), composition, fieldNames, forAll, basicThermo::he(), Foam::name(), IOobject::name(), basicSpecieMixture::solve(), Y, and basicSpecieMixture::Y().
|
virtual |
Add source to continuity equation.
Definition at line 200 of file clouds.C.
References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, IOobject::name(), fvMatrix< Type >::psi(), and Foam::type().
Referenced by clouds::addSup(), and clouds::correct().
|
virtual |
Add source to enthalpy or species equation.
Definition at line 226 of file clouds.C.
References clouds::addSup(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, basicThermo::he(), Foam::Info, IOobject::name(), fvMatrix< Type >::psi(), and Foam::type().
Add source to incompressible momentum equation.
Definition at line 274 of file clouds.C.
References clouds::addSup(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, IOobject::name(), fvMatrix< Type >::psi(), and Foam::type().
|
virtual |
Add source to compressible momentum equation.
Definition at line 300 of file clouds.C.
References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, IOobject::name(), fvMatrix< Type >::psi(), and Foam::type().
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
delete |
Disallow default bitwise assignment.