Public Member Functions | List of all members
NoInjection< CloudType > Class Template Reference

Place holder for 'none' option. More...

Inheritance diagram for NoInjection< CloudType >:
Inheritance graph
[legend]
Collaboration diagram for NoInjection< CloudType >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("none")
 
 NoInjection (const dictionary &, CloudType &, const word &)
 
 NoInjection (const NoInjection< CloudType > &im)
 
virtual autoPtr< InjectionModel< CloudType > > clone () const
 
virtual ~NoInjection ()
 
bool active () const
 
scalar timeEnd () const
 
virtual label parcelsToInject (const scalar time0, const scalar time1)
 
virtual scalar volumeToInject (const scalar time0, const scalar time1)
 
virtual void setPositionAndCell (const label parcelI, const label nParcels, const scalar time, vector &position, label &cellOwner, label &tetFacei, label &tetPti)
 
virtual void setProperties (const label parcelI, const label nParcels, const scalar time, typename CloudType::parcelType &parcel)
 
virtual bool fullyDescribed () const
 
virtual bool validInjection (const label parcelI)
 
- Public Member Functions inherited from InjectionModel< CloudType >
 TypeName ("injectionModel")
 
 declareRunTimeSelectionTable (autoPtr, InjectionModel, dictionary,(const dictionary &dict, CloudType &owner, const word &modelType),(dict, owner, modelType))
 
 InjectionModel (CloudType &owner)
 
 InjectionModel (const dictionary &dict, CloudType &owner, const word &modelName, const word &modelType)
 
 InjectionModel (const InjectionModel< CloudType > &im)
 
virtual ~InjectionModel ()=default
 
virtual void updateMesh ()
 
scalar timeStart () const
 
scalar volumeTotal () const
 
scalar massTotal () const
 
scalar massInjected () const
 
label injectorID () const
 
virtual scalar averageParcelMass ()
 
label nInjections () const
 
label parcelsAddedTotal () const
 
template<class TrackCloudType >
void inject (TrackCloudType &cloud, typename CloudType::parcelType::trackingData &td)
 
template<class TrackCloudType >
void injectSteadyState (TrackCloudType &cloud, typename CloudType::parcelType::trackingData &td, const scalar trackTime)
 
virtual void info (Ostream &os)
 
- Public Member Functions inherited from CloudSubModelBase< CloudType >
 CloudSubModelBase (CloudType &owner)
 
 CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 
 CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)
 
 CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)
 
virtual ~CloudSubModelBase ()
 
const CloudTypeowner () const
 
virtual bool writeTime () const
 
virtual fileName localPath () const
 
CloudTypeowner ()
 
virtual void write (Ostream &os) const
 
- Public Member Functions inherited from subModelBase
 subModelBase (dictionary &properties)
 
 subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 
 subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
 
 subModelBase (const subModelBase &smb)
 
virtual ~subModelBase ()
 
const wordmodelName () const
 
const dictionarydict () const
 
const wordbaseName () const
 
const wordmodelType () const
 
const dictionarycoeffDict () const
 
const dictionaryproperties () const
 
virtual bool defaultCoeffs (const bool printMsg) const
 
virtual void cacheFields (const bool store)
 
template<class Type >
Type getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
void getBaseProperty (const word &entryName, Type &value) const
 
template<class Type >
void setBaseProperty (const word &entryName, const Type &value)
 
bool getModelDict (const word &entryName, dictionary &dict) const
 
template<class Type >
void getModelProperty (const word &entryName, Type &value) const
 
template<class Type >
Type getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
void setModelProperty (const word &entryName, const Type &value)
 

Additional Inherited Members

- Public Types inherited from InjectionModel< CloudType >
enum  parcelBasis { pbNumber, pbMass, pbFixed }
 
typedef CloudType::parcelType parcelType
 
- Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType cloudType
 
- Static Public Member Functions inherited from InjectionModel< CloudType >
static autoPtr< InjectionModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 
static autoPtr< InjectionModel< CloudType > > New (const dictionary &dict, const word &modelName, const word &modelType, CloudType &owner)
 
- Protected Member Functions inherited from InjectionModel< CloudType >
virtual bool prepareForNextTimeStep (const scalar time, label &newParcels, scalar &newVolumeFraction)
 
virtual bool findCellAtPosition (label &celli, label &tetFacei, label &tetPti, vector &position, bool errorOnNotFound=true)
 
virtual scalar setNumberOfParticles (const label parcels, const scalar volumeFraction, const scalar diameter, const scalar rho)
 
virtual void postInjectCheck (const label parcelsAdded, const scalar massAdded)
 
- Protected Member Functions inherited from subModelBase
bool inLine () const
 
- Protected Attributes inherited from InjectionModel< CloudType >
scalar SOI_
 
scalar volumeTotal_
 
scalar massTotal_
 
autoPtr< Function1< scalar > > massFlowRate_
 
scalar massInjected_
 
label nInjections_
 
label parcelsAddedTotal_
 
parcelBasis parcelBasis_
 
scalar nParticleFixed_
 
scalar time0_
 
scalar timeStep0_
 
scalar minParticlesPerParcel_
 
scalar delayedVolume_
 
label injectorID_
 
bool ignoreOutOfBounds_
 
- Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudTypeowner_
 
- Protected Attributes inherited from subModelBase
const word modelName_
 
dictionaryproperties_
 
const dictionary dict_
 
const word baseName_
 
const word modelType_
 
const dictionary coeffDict_
 

Detailed Description

template<class CloudType>
class Foam::NoInjection< CloudType >

Place holder for 'none' option.

Source files

Definition at line 50 of file NoInjection.H.

Constructor & Destructor Documentation

◆ NoInjection() [1/2]

NoInjection ( const dictionary ,
CloudType owner,
const word  
)

Definition at line 28 of file NoInjection.C.

◆ NoInjection() [2/2]

NoInjection ( const NoInjection< CloudType > &  im)

Definition at line 39 of file NoInjection.C.

◆ ~NoInjection()

~NoInjection
virtual

Definition at line 48 of file NoInjection.C.

Member Function Documentation

◆ TypeName()

TypeName ( "none"  )

◆ clone()

virtual autoPtr<InjectionModel<CloudType> > clone ( ) const
inlinevirtual

Implements InjectionModel< CloudType >.

Definition at line 70 of file NoInjection.H.

◆ active()

bool active
virtual

Reimplemented from subModelBase.

Definition at line 55 of file NoInjection.C.

◆ timeEnd()

Foam::scalar timeEnd
virtual

Implements InjectionModel< CloudType >.

Definition at line 62 of file NoInjection.C.

◆ parcelsToInject()

Foam::label parcelsToInject ( const scalar  time0,
const scalar  time1 
)
virtual

Implements InjectionModel< CloudType >.

Definition at line 70 of file NoInjection.C.

◆ volumeToInject()

Foam::scalar volumeToInject ( const scalar  time0,
const scalar  time1 
)
virtual

Implements InjectionModel< CloudType >.

Definition at line 81 of file NoInjection.C.

◆ setPositionAndCell()

void setPositionAndCell ( const label  parcelI,
const label  nParcels,
const scalar  time,
vector position,
label &  cellOwner,
label &  tetFacei,
label &  tetPti 
)
virtual

Implements InjectionModel< CloudType >.

Definition at line 92 of file NoInjection.C.

◆ setProperties()

void setProperties ( const label  parcelI,
const label  nParcels,
const scalar  time,
typename CloudType::parcelType parcel 
)
virtual

Implements InjectionModel< CloudType >.

Definition at line 106 of file NoInjection.C.

References Foam::Zero.

◆ fullyDescribed()

bool fullyDescribed
virtual

Implements InjectionModel< CloudType >.

Definition at line 122 of file NoInjection.C.

◆ validInjection()

bool validInjection ( const label  parcelI)
virtual

Implements InjectionModel< CloudType >.

Definition at line 129 of file NoInjection.C.


The documentation for this class was generated from the following files: