Templated base class for kinematic cloud. More...
#include <lagrangianIntermediate/KinematicCloud_.H>
Templated base class for kinematic cloud.
Definition at line 84 of file KinematicCloud_.H.
Inheritance diagram for KinematicCloud< ParcelType >: Collaboration diagram for KinematicCloud< ParcelType >:Public Types | |
| typedef ParcelType | parcelType |
| Type of parcel the cloud was instantiated for.
| |
Public Member Functions | |
| KinematicCloud (const word &cloudName, const volScalarField &rho, const volVectorField &U, const volScalarField &mu, const dimensionedVector &g, bool readFields=true) | |
| Construct given carrier gas fields.
| |
| virtual | ~KinematicCloud () |
| Destructor.
| |
| const fvMesh & | mesh () const |
| Return refernce to the mesh.
| |
| const IOdictionary & | particleProperties () const |
| Return particle properties dictionary.
| |
| const ParcelType::constantProperties & | constProps () const |
| Return the constant properties.
| |
| const Switch | active () const |
| Return the active flag.
| |
| label | parcelTypeId () const |
| Return the parcel type id.
| |
| const Switch | coupled () const |
| Return coupled flag.
| |
| const Switch | cellValueSourceCorrection () const |
| Return cell value correction flag.
| |
| Random & | rndGen () |
| Return refernce to the random object.
| |
| const volVectorField & | U () const |
| Return carrier gas velocity.
| |
| const volScalarField & | rho () const |
| Return carrier gas density.
| |
| const volScalarField & | mu () const |
| Return carrier gas dynamic viscosity.
| |
| const dimensionedVector & | g () const |
| Gravity.
| |
| const particleForces & | forces () const |
| Optional particle forces.
| |
| const dictionary & | interpolationSchemes () const |
| Return reference to the interpolation dictionary.
| |
| const DispersionModel < KinematicCloud< ParcelType > > & | dispersion () const |
| Return const-access to the dispersion model.
| |
| DispersionModel < KinematicCloud< ParcelType > > & | dispersion () |
| Return reference to the dispersion model.
| |
| const DragModel < KinematicCloud< ParcelType > > & | drag () const |
| Return const-access to the drag model.
| |
| const InjectionModel < KinematicCloud< ParcelType > > & | injection () const |
| Return const access to the injection model.
| |
| InjectionModel< KinematicCloud < ParcelType > > & | injection () |
| Return reference to the injection model.
| |
| const PatchInteractionModel < KinematicCloud< ParcelType > > & | patchInteraction () const |
| Return const-access to the patch interaction model.
| |
| PostProcessingModel < KinematicCloud< ParcelType > > & | postProcessing () |
| Return reference to post-processing model.
| |
| const vectorIntegrationScheme & | UIntegrator () const |
| Return reference to velocity integration.
| |
| DimensionedField< vector, volMesh > & | UTrans () |
| Return reference to momentum source.
| |
| tmp< DimensionedField< vector, volMesh > > | SU () const |
| Return tmp momentum source term - fully explicit.
| |
| scalar | massInjected () const |
| Total mass injected.
| |
| scalar | massInSystem () const |
| Total mass in system.
| |
| void | info () const |
| Print cloud information.
| |
| const tmp< volScalarField > | theta () const |
| Return the particle volume fraction field.
| |
| const tmp< volScalarField > | alpha () const |
| Return the particle mass fraction field.
| |
| const tmp< volScalarField > | rhoEff () const |
| Return the particle effective density field.
| |
| void | checkParcelProperties (ParcelType &parcel, const scalar lagrangianDt, const bool fullyDescribed) |
| Check parcel properties.
| |
| void | resetSourceTerms () |
| Reset the spray source terms.
| |
| void | evolve () |
| Evolve the spray (inject, inject)
| |
Protected Member Functions | |
| void | preEvolve () |
| Pre-evolve.
| |
| void | evolveCloud () |
| Evolve the cloud.
| |
| void | postEvolve () |
| Post-evolve.
| |
Protected Attributes | |
| const fvMesh & | mesh_ |
| References to the mesh and time databases.
| |
| IOdictionary | particleProperties_ |
| Dictionary of particle properties.
| |
| ParcelType::constantProperties | constProps_ |
| Parcel constant properties.
| |
| const Switch | active_ |
| Cloud active flag.
| |
| const label | parcelTypeId_ |
| Parcel type id - used to flag the type of parcels issued by this.
| |
| const Switch | coupled_ |
| Flag to indicate whether parcels are coupled to the carrier phase.
| |
| const Switch | cellValueSourceCorrection_ |
| Flag to correct cell values with latest transfer information.
| |
| Random | rndGen_ |
| Random number generator - used by some injection routines.
| |
| const volScalarField & | rho_ |
| Density.
| |
| const volVectorField & | U_ |
| Velocity.
| |
| const volScalarField & | mu_ |
| Dynamic viscosity.
| |
| const dimensionedVector & | g_ |
| Gravity.
| |
| particleForces | forces_ |
| Optional particle forces.
| |
| dictionary | interpolationSchemes_ |
| Interpolation schemes dictionary.
| |
| autoPtr< DispersionModel < KinematicCloud< ParcelType > > > | dispersionModel_ |
| Dispersion model.
| |
| autoPtr< DragModel < KinematicCloud< ParcelType > > > | dragModel_ |
| Drag transfer model.
| |
| autoPtr< InjectionModel < KinematicCloud< ParcelType > > > | injectionModel_ |
| Injector model.
| |
| autoPtr< PatchInteractionModel < KinematicCloud< ParcelType > > > | patchInteractionModel_ |
| Patch interaction model.
| |
| autoPtr< PostProcessingModel < KinematicCloud< ParcelType > > > | postProcessingModel_ |
| Post-processing model.
| |
| autoPtr< vectorIntegrationScheme > | UIntegrator_ |
| Velocity integration.
| |
| DimensionedField< vector, volMesh > | UTrans_ |
| Momentum.
| |
| typedef ParcelType parcelType |
Type of parcel the cloud was instantiated for.
Reimplemented in ReactingCloud< ParcelType >, ReactingMultiphaseCloud< ParcelType >, and ThermoCloud< ParcelType >.
Definition at line 222 of file KinematicCloud_.H.
| KinematicCloud | ( | const word & | cloudName, |
| const volScalarField & | rho, | ||
| const volVectorField & | U, | ||
| const volScalarField & | mu, | ||
| const dimensionedVector & | g, | ||
| bool | readFields = true
|
||
| ) |
Construct given carrier gas fields.
Definition at line 110 of file KinematicCloud_.C.
References Foam::readFields().
| ~KinematicCloud | ( | ) | [virtual]
|
Destructor.
Definition at line 221 of file KinematicCloud_.C.
| void preEvolve | ( | ) | [protected]
|
Pre-evolve.
Reimplemented in ReactingCloud< ParcelType >, ReactingMultiphaseCloud< ParcelType >, and ThermoCloud< ParcelType >.
Definition at line 39 of file KinematicCloud_.C.
| void evolveCloud | ( | ) | [protected]
|
Evolve the cloud.
Reimplemented in ReactingCloud< ParcelType >, ReactingMultiphaseCloud< ParcelType >, and ThermoCloud< ParcelType >.
Definition at line 47 of file KinematicCloud_.C.
| void postEvolve | ( | ) | [protected]
|
Post-evolve.
Reimplemented in ReactingCloud< ParcelType >, ReactingMultiphaseCloud< ParcelType >, and ThermoCloud< ParcelType >.
Definition at line 92 of file KinematicCloud_.C.
| const Foam::fvMesh & mesh | ( | ) | const [inline]
|
Return refernce to the mesh.
Definition at line 38 of file KinematicCloudI_.H.
| const Foam::IOdictionary & particleProperties | ( | ) | const [inline]
|
Return particle properties dictionary.
Definition at line 46 of file KinematicCloudI_.H.
| const ParcelType::constantProperties & constProps | ( | ) | const [inline]
|
Return the constant properties.
Reimplemented in ReactingCloud< ParcelType >, ReactingMultiphaseCloud< ParcelType >, and ThermoCloud< ParcelType >.
Definition at line 54 of file KinematicCloudI_.H.
| const Foam::Switch active | ( | ) | const [inline]
|
Return the active flag.
Definition at line 61 of file KinematicCloudI_.H.
| Foam::label parcelTypeId | ( | ) | const [inline]
|
Return the parcel type id.
Definition at line 31 of file KinematicCloudI_.H.
| const Foam::Switch coupled | ( | ) | const [inline]
|
Return coupled flag.
Definition at line 68 of file KinematicCloudI_.H.
| const Foam::Switch cellValueSourceCorrection | ( | ) | const [inline]
|
Return cell value correction flag.
Definition at line 76 of file KinematicCloudI_.H.
| Foam::Random & rndGen | ( | ) | [inline]
|
Return refernce to the random object.
Definition at line 207 of file KinematicCloudI_.H.
| const Foam::volVectorField & U | ( | ) | const [inline]
|
Return carrier gas velocity.
Definition at line 91 of file KinematicCloudI_.H.
| const Foam::volScalarField & rho | ( | ) | const [inline]
|
Return carrier gas density.
Definition at line 84 of file KinematicCloudI_.H.
| const Foam::volScalarField & mu | ( | ) | const [inline]
|
Return carrier gas dynamic viscosity.
Definition at line 98 of file KinematicCloudI_.H.
| const Foam::dimensionedVector & g | ( | ) | const [inline]
|
Gravity.
Definition at line 106 of file KinematicCloudI_.H.
| const Foam::particleForces & forces | ( | ) | const [inline]
|
Optional particle forces.
Definition at line 114 of file KinematicCloudI_.H.
| const Foam::dictionary & interpolationSchemes | ( | ) | const [inline]
|
Return reference to the interpolation dictionary.
Definition at line 122 of file KinematicCloudI_.H.
| const Foam::DispersionModel< Foam::KinematicCloud< ParcelType > > & dispersion | ( | ) | const [inline]
|
Return const-access to the dispersion model.
Definition at line 130 of file KinematicCloudI_.H.
| Foam::DispersionModel< Foam::KinematicCloud< ParcelType > > & dispersion | ( | ) | [inline]
|
Return reference to the dispersion model.
Definition at line 138 of file KinematicCloudI_.H.
| const Foam::DragModel< Foam::KinematicCloud< ParcelType > > & drag | ( | ) | const [inline]
|
Return const-access to the drag model.
Definition at line 146 of file KinematicCloudI_.H.
| const Foam::InjectionModel< Foam::KinematicCloud< ParcelType > > & injection | ( | ) | const [inline]
|
Return const access to the injection model.
Definition at line 154 of file KinematicCloudI_.H.
| Foam::InjectionModel< Foam::KinematicCloud< ParcelType > > & injection | ( | ) | [inline]
|
Return reference to the injection model.
Definition at line 170 of file KinematicCloudI_.H.
| const Foam::PatchInteractionModel< Foam::KinematicCloud< ParcelType > > & patchInteraction | ( | ) | const [inline]
|
Return const-access to the patch interaction model.
Definition at line 162 of file KinematicCloudI_.H.
| Foam::PostProcessingModel< Foam::KinematicCloud< ParcelType > > & postProcessing | ( | ) | [inline]
|
Return reference to post-processing model.
Definition at line 178 of file KinematicCloudI_.H.
| const Foam::vectorIntegrationScheme & UIntegrator | ( | ) | const [inline]
|
Return reference to velocity integration.
Definition at line 186 of file KinematicCloudI_.H.
| Foam::DimensionedField< Foam::vector, Foam::volMesh > & UTrans | ( | ) | [inline]
|
Return reference to momentum source.
Definition at line 215 of file KinematicCloudI_.H.
| Foam::tmp< Foam::DimensionedField< Foam::vector, Foam::volMesh > > SU | ( | ) | const [inline]
|
Return tmp momentum source term - fully explicit.
Definition at line 223 of file KinematicCloudI_.H.
References Foam::dimDensity, Foam::dimTime, Foam::dimVelocity, mesh, name(), and timeName.
| scalar massInjected | ( | ) | const [inline]
|
Total mass injected.
| Foam::scalar massInSystem | ( | ) | const [inline]
|
Total mass in system.
Definition at line 193 of file KinematicCloudI_.H.
References forAllConstIter, and p.
| void info | ( | ) | const |
Print cloud information.
Reimplemented from IOobject.
Reimplemented in ReactingCloud< ParcelType >, ReactingMultiphaseCloud< ParcelType >, and ThermoCloud< ParcelType >.
Definition at line 270 of file KinematicCloud_.C.
References Foam::Info, name(), Foam::nl, and Foam::returnReduce().
| const Foam::tmp< Foam::volScalarField > theta | ( | ) | const [inline]
|
Return the particle volume fraction field.
Note: for particles belonging to this cloud only
Definition at line 256 of file KinematicCloudI_.H.
References Foam::dimless, forAllConstIter, mesh, name(), p, timeName, and fvMesh::V().
| const Foam::tmp< Foam::volScalarField > alpha | ( | ) | const [inline]
|
Return the particle mass fraction field.
Note: for particles belonging to this cloud only
Definition at line 293 of file KinematicCloudI_.H.
References Foam::dimless, forAllConstIter, mesh, name(), p, timeName, and fvMesh::V().
| const Foam::tmp< Foam::volScalarField > rhoEff | ( | ) | const [inline]
|
Return the particle effective density field.
Note: for particles belonging to this cloud only
Definition at line 330 of file KinematicCloudI_.H.
References Foam::dimDensity, forAllConstIter, mesh, name(), p, timeName, and fvMesh::V().
| void checkParcelProperties | ( | ParcelType & | parcel, |
| const scalar | lagrangianDt, | ||
| const bool | fullyDescribed | ||
| ) |
Check parcel properties.
Reimplemented in ReactingCloud< ParcelType >, ReactingMultiphaseCloud< ParcelType >, and ThermoCloud< ParcelType >.
Definition at line 229 of file KinematicCloud_.C.
| void resetSourceTerms | ( | ) |
Reset the spray source terms.
Reimplemented in ReactingCloud< ParcelType >, ReactingMultiphaseCloud< ParcelType >, and ThermoCloud< ParcelType >.
Definition at line 246 of file KinematicCloud_.C.
| void evolve | ( | ) |
Evolve the spray (inject, inject)
Reimplemented in ReactingCloud< ParcelType >, ReactingMultiphaseCloud< ParcelType >, and ThermoCloud< ParcelType >.
Definition at line 253 of file KinematicCloud_.C.
References Foam::endl(), and Foam::Info.
References to the mesh and time databases.
Definition at line 103 of file KinematicCloud_.H.
IOdictionary particleProperties_ [protected]
|
Dictionary of particle properties.
Definition at line 106 of file KinematicCloud_.H.
ParcelType::constantProperties constProps_ [protected]
|
Parcel constant properties.
Reimplemented in ReactingCloud< ParcelType >, ReactingMultiphaseCloud< ParcelType >, and ThermoCloud< ParcelType >.
Definition at line 109 of file KinematicCloud_.H.
Cloud active flag.
Definition at line 112 of file KinematicCloud_.H.
const label parcelTypeId_ [protected]
|
Parcel type id - used to flag the type of parcels issued by this.
cloud
Definition at line 116 of file KinematicCloud_.H.
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 120 of file KinematicCloud_.H.
const Switch cellValueSourceCorrection_ [protected]
|
Flag to correct cell values with latest transfer information.
during the lagrangian timestep
Definition at line 124 of file KinematicCloud_.H.
Random number generator - used by some injection routines.
Definition at line 127 of file KinematicCloud_.H.
const volScalarField& rho_ [protected]
|
Density.
Definition at line 133 of file KinematicCloud_.H.
const volVectorField& U_ [protected]
|
Velocity.
Definition at line 136 of file KinematicCloud_.H.
const volScalarField& mu_ [protected]
|
Dynamic viscosity.
Definition at line 139 of file KinematicCloud_.H.
const dimensionedVector& g_ [protected]
|
Gravity.
Definition at line 145 of file KinematicCloud_.H.
particleForces forces_ [protected]
|
Optional particle forces.
Definition at line 149 of file KinematicCloud_.H.
dictionary interpolationSchemes_ [protected]
|
Interpolation schemes dictionary.
Definition at line 152 of file KinematicCloud_.H.
autoPtr<DispersionModel<KinematicCloud<ParcelType> > > dispersionModel_ [protected]
|
Dispersion model.
Definition at line 159 of file KinematicCloud_.H.
autoPtr<DragModel<KinematicCloud<ParcelType> > > dragModel_ [protected]
|
Drag transfer model.
Definition at line 162 of file KinematicCloud_.H.
autoPtr<InjectionModel<KinematicCloud<ParcelType> > > injectionModel_ [protected]
|
Injector model.
Definition at line 166 of file KinematicCloud_.H.
autoPtr<PatchInteractionModel<KinematicCloud<ParcelType> > > patchInteractionModel_ [protected]
|
Patch interaction model.
Definition at line 170 of file KinematicCloud_.H.
autoPtr<PostProcessingModel<KinematicCloud<ParcelType> > > postProcessingModel_ [protected]
|
Post-processing model.
Definition at line 174 of file KinematicCloud_.H.
autoPtr<vectorIntegrationScheme> UIntegrator_ [protected]
|
Velocity integration.
Definition at line 180 of file KinematicCloud_.H.
DimensionedField<vector, volMesh> UTrans_ [protected]
|
Momentum.
Definition at line 186 of file KinematicCloud_.H.
