Function object which generates fields of the number and mass and rates thereof of collisions per unit area on all patches. Can optionally take a minimum speed below which a collision is not counted. More...
Public Member Functions | |
TypeName ("patchCollisionDensity") | |
Runtime type information. More... | |
PatchCollisionDensity (const dictionary &dict, CloudType &owner, const word &modelName) | |
Construct from dictionary. More... | |
PatchCollisionDensity (const PatchCollisionDensity< CloudType > &ppm) | |
Construct copy. More... | |
virtual autoPtr< CloudFunctionObject< CloudType > > | clone () const |
Construct and return a clone. More... | |
virtual | ~PatchCollisionDensity () |
Destructor. More... | |
virtual void | preEvolve () |
Pre-evolve hook. More... | |
virtual void | preFace (const parcelType &p) |
Pre-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 () |
Destructor. More... | |
virtual void | postEvolve () |
Post-evolve hook. More... | |
virtual void | postMove (typename CloudType::parcelType &p, const scalar dt, const point &position0, bool &keepParticle) |
Post-move hook. More... | |
virtual void | postPatch (const typename CloudType::parcelType &p, const polyPatch &pp) |
Post-patch hook. More... | |
virtual void | preFace (const typename CloudType::parcelType &p) |
Pre-face hook. More... | |
virtual void | postFace (const typename CloudType::parcelType &p) |
Post-face 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) | |
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 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... | |
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... | |
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... | |
Function object which generates fields of the number and mass and rates thereof of collisions per unit area on all patches. Can optionally take a minimum speed below which a collision is not counted.
Example usage:
patchCollisionDensity1 { type patchCollisionDensity; minSpeed 1e-3; }
Definition at line 60 of file PatchCollisionDensity.H.
PatchCollisionDensity | ( | const dictionary & | dict, |
CloudType & | owner, | ||
const word & | modelName | ||
) |
Construct from dictionary.
Definition at line 113 of file PatchCollisionDensity.C.
References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), typeIOobject< Type >::headerOk(), IOobject::MUST_READ, Foam::name(), IOobject::NO_WRITE, and CloudSubModelBase< CloudType >::owner().
PatchCollisionDensity | ( | const PatchCollisionDensity< CloudType > & | ppm | ) |
Construct copy.
Definition at line 196 of file PatchCollisionDensity.C.
|
virtual |
Destructor.
Definition at line 230 of file PatchCollisionDensity.C.
|
protectedvirtual |
Write post-processing info.
Reimplemented from CloudFunctionObject< CloudType >.
Definition at line 38 of file PatchCollisionDensity.C.
References Foam::dimArea, Foam::dimless, Foam::dimMass, Foam::dimTime, and Foam::name().
TypeName | ( | "patchCollisionDensity" | ) |
Runtime type information.
|
inlinevirtual |
Construct and return a clone.
Reimplemented from CloudFunctionObject< CloudType >.
Definition at line 117 of file PatchCollisionDensity.H.
|
virtual |
Pre-evolve hook.
Reimplemented from CloudFunctionObject< CloudType >.
Definition at line 237 of file PatchCollisionDensity.C.
References fvMesh::boundary(), fvMesh::conformal(), forAll, fvMesh::mesh(), patchi, and fvPatch::size().
|
virtual |
Pre-face hook.
Definition at line 283 of file PatchCollisionDensity.C.
References polyMesh::boundaryMesh(), polyPatch::coupled(), patchIdentifier::index(), fvMesh::mesh(), p, patchi, and polyPatch::start().