Injection positions specified by a particle number density within a cell set. More...
Public Member Functions | |
TypeName ("cellZoneInjection") | |
Runtime type information. More... | |
CellZoneInjection (const dictionary &dict, CloudType &owner, const word &modelName) | |
Construct from dictionary. More... | |
CellZoneInjection (const CellZoneInjection< CloudType > &im) | |
Construct copy. More... | |
virtual autoPtr< InjectionModel< CloudType > > | clone () const |
Construct and return a clone. More... | |
virtual | ~CellZoneInjection () |
Destructor. More... | |
virtual void | updateMesh () |
Set injector locations when mesh is updated. More... | |
scalar | timeEnd () const |
Return the end-of-injection time. More... | |
label | parcelsToInject (const scalar time0, const scalar time1) |
Number of parcels to introduce relative to SOI. More... | |
scalar | volumeToInject (const scalar time0, const scalar time1) |
Volume of parcels to introduce relative to SOI. More... | |
virtual void | setPositionAndCell (const label parcelI, const label nParcels, const scalar time, vector &position, label &cellOwner, label &tetFacei, label &tetPti) |
Set the injection position and owner cell, tetFace and tetPt. More... | |
virtual void | setProperties (const label parcelI, const label nParcels, const scalar time, typename CloudType::parcelType &parcel) |
Set the parcel properties. More... | |
virtual bool | fullyDescribed () const |
Flag to identify whether model fully describes the parcel. More... | |
virtual bool | validInjection (const label parcelI) |
Return flag to identify whether or not injection of parcelI is. More... | |
Public Member Functions inherited from InjectionModel< CloudType > | |
TypeName ("injectionModel") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, InjectionModel, dictionary,(const dictionary &dict, CloudType &owner, const word &modelType),(dict, owner, modelType)) | |
Declare runtime constructor selection table. More... | |
InjectionModel (CloudType &owner) | |
Construct null from owner. More... | |
InjectionModel (const dictionary &dict, CloudType &owner, const word &modelName, const word &modelType) | |
Construct from dictionary. More... | |
InjectionModel (const InjectionModel< CloudType > &im) | |
Construct copy. More... | |
virtual | ~InjectionModel () |
Destructor. More... | |
scalar | timeStart () const |
Return the start-of-injection time. More... | |
scalar | volumeTotal () const |
Return the total volume to be injected across the event. More... | |
scalar | massTotal () const |
Return mass of particles to introduce. More... | |
scalar | massInjected () const |
Return mass of particles injected (cumulative) More... | |
virtual scalar | averageParcelMass () |
Return the average parcel mass over the injection period. More... | |
label | nInjections () const |
Return the number of injections. More... | |
label | parcelsAddedTotal () const |
Return the total number parcels added. More... | |
template<class TrackCloudType > | |
void | inject (TrackCloudType &cloud, typename CloudType::parcelType::trackingData &td) |
Main injection loop. More... | |
template<class TrackCloudType > | |
void | injectSteadyState (TrackCloudType &cloud, typename CloudType::parcelType::trackingData &td, const scalar trackTime) |
Main injection loop - steady-state. More... | |
virtual void | info (Ostream &os) |
Write injection info to stream. More... | |
Public Member Functions inherited from CloudSubModelBase< CloudType > | |
CloudSubModelBase (CloudType &owner) | |
Construct null from owner cloud. More... | |
CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs") | |
Construct from owner cloud without name. More... | |
CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType) | |
Construct from owner cloud with name. More... | |
CloudSubModelBase (const CloudSubModelBase< CloudType > &smb) | |
Copy constructor. More... | |
virtual | ~CloudSubModelBase () |
Destructor. More... | |
const CloudType & | owner () const |
Return const access to the owner cloud. More... | |
virtual bool | writeTime () const |
Flag to indicate when to write a property. More... | |
CloudType & | owner () |
Return non-const access to the owner cloud for manipulation. More... | |
virtual void | write (Ostream &os) const |
Write. More... | |
Public Member Functions inherited from subModelBase | |
subModelBase (dictionary &properties) | |
Construct null. More... | |
subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs") | |
Construct from components without name. More... | |
subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType) | |
Construct from components with name. More... | |
subModelBase (const subModelBase &smb) | |
Copy constructor. More... | |
virtual | ~subModelBase () |
Destructor. More... | |
const word & | modelName () const |
Return const access to the name of the sub-model. More... | |
const dictionary & | dict () const |
Return const access to the cloud dictionary. More... | |
const word & | baseName () const |
Return const access to the base name of the sub-model. More... | |
const word & | modelType () const |
Return const access to the sub-model type. More... | |
const dictionary & | coeffDict () const |
Return const access to the coefficients dictionary. More... | |
const dictionary & | properties () const |
Return const access to the properties dictionary. More... | |
virtual bool | defaultCoeffs (const bool printMsg) const |
Returns true if defaultCoeffs is true and outputs on printMsg. More... | |
virtual bool | active () const |
Return the model 'active' status - default active = true. More... | |
virtual void | cacheFields (const bool store) |
Cache dependent sub-model fields. More... | |
template<class Type > | |
Type | getBaseProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const |
Retrieve generic property from the base model. More... | |
template<class Type > | |
void | getBaseProperty (const word &entryName, Type &value) const |
Retrieve generic property from the base model. More... | |
template<class Type > | |
void | setBaseProperty (const word &entryName, const Type &value) |
Add generic property to the base model. More... | |
template<class Type > | |
void | getModelProperty (const word &entryName, Type &value) const |
Retrieve generic property from the sub-model. More... | |
template<class Type > | |
Type | getModelProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const |
Retrieve generic property from the sub-model. More... | |
template<class Type > | |
void | setModelProperty (const word &entryName, const Type &value) |
Add generic property to the sub-model. More... | |
void | operator= (const subModelBase &)=delete |
Disallow default bitwise assignment. More... | |
Additional Inherited Members | |
Public Types inherited from InjectionModel< CloudType > | |
enum | parcelBasis { pbNumber, pbMass, pbFixed } |
Parcel basis representation options. More... | |
typedef CloudType::parcelType | parcelType |
Convenience typedef for parcelType. More... | |
Public Types inherited from CloudSubModelBase< CloudType > | |
typedef CloudType | cloudType |
Type of cloud this model was instantiated for. More... | |
Static Public Member Functions inherited from InjectionModel< CloudType > | |
static autoPtr< InjectionModel< CloudType > > | New (const dictionary &dict, CloudType &owner) |
Selector with lookup from dictionary. More... | |
static autoPtr< InjectionModel< CloudType > > | New (const dictionary &dict, const word &modelName, const word &modelType, CloudType &owner) |
Selector with name and type. More... | |
Protected Member Functions inherited from InjectionModel< CloudType > | |
virtual bool | prepareForNextTimeStep (const scalar time, label &newParcels, scalar &newVolumeFraction) |
Determine properties for next time step/injection interval. More... | |
virtual bool | findCellAtPosition (label &celli, label &tetFacei, label &tetPti, vector &position, bool errorOnNotFound=true) |
Find the cell that contains the supplied position. More... | |
virtual scalar | setNumberOfParticles (const label parcels, const scalar volumeFraction, const scalar diameter, const scalar rho) |
Set number of particles to inject given parcel properties. More... | |
virtual void | postInjectCheck (const label parcelsAdded, const scalar massAdded) |
Post injection checks. More... | |
Protected Member Functions inherited from subModelBase | |
bool | inLine () const |
Flag to indicate whether data is/was read in-line. More... | |
Protected Attributes inherited from InjectionModel< CloudType > | |
scalar | SOI_ |
Start of injection [s]. More... | |
scalar | volumeTotal_ |
Total volume of particles introduced by this injector [m^3]. More... | |
scalar | massTotal_ |
Total mass to inject [kg]. More... | |
TimeFunction1< scalar > | massFlowRate_ |
Mass flow rate profile for steady calculations. More... | |
scalar | massInjected_ |
Total mass injected to date [kg]. More... | |
label | nInjections_ |
Number of injections counter. More... | |
label | parcelsAddedTotal_ |
Running counter of total number of parcels added. More... | |
parcelBasis | parcelBasis_ |
Parcel basis enumeration. More... | |
scalar | nParticleFixed_ |
nParticle to assign to parcels when the 'fixed' basis More... | |
scalar | time0_ |
Continuous phase time at start of injection time step [s]. More... | |
scalar | timeStep0_ |
Time at start of injection time step [s]. More... | |
Protected Attributes inherited from CloudSubModelBase< CloudType > | |
CloudType & | owner_ |
Reference to the cloud. More... | |
Protected Attributes inherited from subModelBase | |
const word | modelName_ |
Name of the sub-model. More... | |
dictionary & | properties_ |
Reference to properties dictionary e.g. for restart. More... | |
const dictionary | dict_ |
Copy of dictionary used during construction. More... | |
const word | baseName_ |
Name of the sub-model base class. More... | |
const word | modelType_ |
Type of the sub-model. More... | |
const dictionary | coeffDict_ |
Coefficients dictionary. More... | |
Injection positions specified by a particle number density within a cell set.
Properties:
Definition at line 60 of file CellZoneInjection.H.
CellZoneInjection | ( | const dictionary & | dict, |
CloudType & | owner, | ||
const word & | modelName | ||
) |
Construct from dictionary.
Definition at line 165 of file CellZoneInjection.C.
CellZoneInjection | ( | const CellZoneInjection< CloudType > & | im | ) |
Construct copy.
Definition at line 194 of file CellZoneInjection.C.
|
virtual |
Destructor.
Definition at line 214 of file CellZoneInjection.C.
Referenced by CellZoneInjection< CloudType >::clone().
TypeName | ( | "cellZoneInjection" | ) |
Runtime type information.
|
inlinevirtual |
Construct and return a clone.
Implements InjectionModel< CloudType >.
Definition at line 120 of file CellZoneInjection.H.
References CellZoneInjection< CloudType >::fullyDescribed(), CellZoneInjection< CloudType >::parcelsToInject(), CellZoneInjection< CloudType >::setPositionAndCell(), CellZoneInjection< CloudType >::setProperties(), CellZoneInjection< CloudType >::timeEnd(), CellZoneInjection< CloudType >::updateMesh(), CellZoneInjection< CloudType >::validInjection(), CellZoneInjection< CloudType >::volumeToInject(), and CellZoneInjection< CloudType >::~CellZoneInjection().
|
virtual |
Set injector locations when mesh is updated.
Reimplemented from InjectionModel< CloudType >.
Definition at line 221 of file CellZoneInjection.C.
References polyMesh::cellZones(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, ZoneMesh< ZoneType, MeshType >::findZoneID(), forAll, Foam::Info, ZoneMesh< ZoneType, MeshType >::names(), Foam::nl, Foam::constant::mathematical::pi(), Foam::pow3(), Foam::returnReduce(), scalarField(), List< T >::size(), Foam::sum(), fvMesh::V(), and WarningInFunction.
Referenced by CellZoneInjection< CloudType >::clone().
|
virtual |
Return the end-of-injection time.
Implements InjectionModel< CloudType >.
Definition at line 270 of file CellZoneInjection.C.
References CellZoneInjection< CloudType >::parcelsToInject().
Referenced by CellZoneInjection< CloudType >::clone().
|
virtual |
Number of parcels to introduce relative to SOI.
Implements InjectionModel< CloudType >.
Definition at line 279 of file CellZoneInjection.C.
References CellZoneInjection< CloudType >::volumeToInject().
Referenced by CellZoneInjection< CloudType >::clone(), and CellZoneInjection< CloudType >::timeEnd().
|
virtual |
Volume of parcels to introduce relative to SOI.
Implements InjectionModel< CloudType >.
Definition at line 297 of file CellZoneInjection.C.
References CellZoneInjection< CloudType >::setPositionAndCell().
Referenced by CellZoneInjection< CloudType >::clone(), and CellZoneInjection< CloudType >::parcelsToInject().
|
virtual |
Set the injection position and owner cell, tetFace and tetPt.
Implements InjectionModel< CloudType >.
Definition at line 316 of file CellZoneInjection.C.
References CellZoneInjection< CloudType >::setProperties().
Referenced by CellZoneInjection< CloudType >::clone(), and CellZoneInjection< CloudType >::volumeToInject().
|
virtual |
Set the parcel properties.
Implements InjectionModel< CloudType >.
Definition at line 335 of file CellZoneInjection.C.
Referenced by CellZoneInjection< CloudType >::clone(), and CellZoneInjection< CloudType >::setPositionAndCell().
|
virtual |
Flag to identify whether model fully describes the parcel.
Implements InjectionModel< CloudType >.
Definition at line 351 of file CellZoneInjection.C.
Referenced by CellZoneInjection< CloudType >::clone().
|
virtual |
Return flag to identify whether or not injection of parcelI is.
permitted
Implements InjectionModel< CloudType >.
Definition at line 358 of file CellZoneInjection.C.
Referenced by CellZoneInjection< CloudType >::clone().