Removes parcels that hit user-specified face zone faces. More...
Public Member Functions | |
TypeName ("removeParcels") | |
Runtime type information. More... | |
RemoveParcels (const dictionary &dict, CloudType &owner, const word &modelName) | |
Construct from dictionary. More... | |
RemoveParcels (const RemoveParcels< CloudType > &ppm) | |
Construct copy. More... | |
virtual autoPtr< CloudFunctionObject< CloudType > > | clone () const |
Construct and return a clone. More... | |
virtual | ~RemoveParcels ()=default |
Destructor. More... | |
virtual void | postEvolve (const typename parcelType::trackingData &td) |
Post-evolve hook. More... | |
virtual bool | postFace (const parcelType &p, const typename parcelType::trackingData &td) |
Post-face hook. More... | |
Public Member Functions inherited from CloudFunctionObject< CloudType > | |
TypeName ("cloudFunctionObject") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, CloudFunctionObject, dictionary,(const dictionary &dict, CloudType &owner, const word &modelName),(dict, owner, modelName)) | |
Declare runtime constructor selection table. More... | |
CloudFunctionObject (CloudType &owner) | |
Construct null from owner. More... | |
CloudFunctionObject (const dictionary &dict, CloudType &owner, const word &objectType, const word &modelName) | |
Construct from dictionary. More... | |
CloudFunctionObject (const CloudFunctionObject< CloudType > &ppm) | |
Construct copy. More... | |
virtual | ~CloudFunctionObject ()=default |
Destructor. More... | |
virtual void | preEvolve (const typename parcelType::trackingData &td) |
Pre-evolve hook. More... | |
virtual bool | postMove (parcelType &p, const scalar dt, const point &position0, const typename parcelType::trackingData &td) |
Post-move hook. More... | |
virtual bool | postPatch (const parcelType &p, const polyPatch &pp, const typename parcelType::trackingData &td) |
Post-patch hook. More... | |
const fileName & | outputDir () const |
Return the output path. More... | |
fileName | writeTimeDir () const |
Return the output time path. 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) | |
Construct as copy. More... | |
virtual | ~CloudSubModelBase ()=default |
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... | |
virtual fileName | localPath () const |
Output directory. More... | |
CloudType & | owner () |
Return non-const access to the owner cloud for manipulation. More... | |
virtual void | info () |
Write to info. More... | |
virtual void | write (Ostream &os) const |
Write to os. 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) | |
Construct as copy. More... | |
virtual | ~subModelBase ()=default |
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=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... | |
bool | getModelDict (const word &entryName, dictionary &dict) const |
Retrieve dictionary, return true if set. More... | |
template<class Type > | |
bool | 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=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... | |
Protected Member Functions | |
void | write () |
Write post-processing info. More... | |
Protected Member Functions inherited from subModelBase | |
bool | inLine () const |
Flag to indicate whether data is/was read in-line. More... | |
Additional Inherited Members | |
Public Types inherited from CloudSubModelBase< CloudType > | |
typedef CloudType | cloudType |
Type of cloud this model was instantiated for. More... | |
Static Public Member Functions inherited from CloudFunctionObject< CloudType > | |
static autoPtr< CloudFunctionObject< CloudType > > | New (const dictionary &dict, CloudType &owner, const word &objectType, const word &modelName) |
Selector. More... | |
Public Attributes inherited from subModelBase | |
bool | log |
Flag to write log into Info. 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... | |
Removes parcels that hit user-specified face zone faces.
removeParcels1 { type removeParcels; log yes; resetOnWrite no; resetOnStart no; faceZones (cycLeft cycRight); }
Definition at line 64 of file RemoveParcels.H.
RemoveParcels | ( | const dictionary & | dict, |
CloudType & | owner, | ||
const word & | modelName | ||
) |
Construct from dictionary.
Definition at line 143 of file RemoveParcels.C.
References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), ZoneMesh< ZoneType, MeshType >::findZoneID(), forAll, Foam::Info, Foam::nl, pbm, pp(), returnReduce(), UList< T >::size(), and zoneIDs.
RemoveParcels | ( | const RemoveParcels< CloudType > & | ppm | ) |
Construct copy.
Definition at line 225 of file RemoveParcels.C.
|
virtualdefault |
Destructor.
|
protectedvirtual |
Write post-processing info.
Reimplemented from CloudFunctionObject< CloudType >.
Definition at line 100 of file RemoveParcels.C.
References Foam::endl(), forAll, Log_, mesh, os(), returnReduce(), and Time::timeName().
TypeName | ( | "removeParcels" | ) |
Runtime type information.
|
inlinevirtual |
Construct and return a clone.
Reimplemented from CloudFunctionObject< CloudType >.
Definition at line 169 of file RemoveParcels.H.
|
virtual |
Post-evolve hook.
Reimplemented from CloudFunctionObject< CloudType >.
Definition at line 73 of file RemoveParcels.C.
References forAll, Log_, mesh, IOobject::name(), Foam::nl, returnReduce(), and td().
|
virtual |
Post-face hook.
Reimplemented from CloudFunctionObject< CloudType >.
Definition at line 245 of file RemoveParcels.C.
References forAll, UList< T >::found(), and p.