Templated patch interaction model class. More...
Public Types | |
enum | interactionType { itNone , itRebound , itStick , itEscape , itOther } |
Public Types inherited from CloudSubModelBase< CloudType > | |
typedef CloudType | cloudType |
Type of cloud this model was instantiated for. More... | |
Public Member Functions | |
TypeName ("patchInteractionModel") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, PatchInteractionModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner)) | |
Declare runtime constructor selection table. More... | |
PatchInteractionModel (CloudType &owner) | |
Construct null from owner. More... | |
PatchInteractionModel (const dictionary &dict, CloudType &owner, const word &type) | |
Construct from components. More... | |
PatchInteractionModel (const PatchInteractionModel< CloudType > &pim) | |
Construct copy. More... | |
virtual autoPtr< PatchInteractionModel< CloudType > > | clone () const =0 |
Construct and return a clone. More... | |
virtual | ~PatchInteractionModel () |
Destructor. More... | |
const word & | UName () const |
Return name of velocity field. More... | |
virtual bool | correct (typename CloudType::parcelType &p, const polyPatch &pp, bool &keepParticle)=0 |
Apply velocity correction. More... | |
virtual void | info (Ostream &os) |
Write patch interaction 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 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... | |
Static Public Member Functions | |
static autoPtr< PatchInteractionModel< CloudType > > | New (const dictionary &dict, CloudType &owner) |
Selector. More... | |
static word | interactionTypeToWord (const interactionType &itEnum) |
Convert interaction result to word. More... | |
static interactionType | wordToInteractionType (const word &itWord) |
Convert word to interaction result. More... | |
Static Public Attributes | |
static wordList | interactionTypeNames_ |
Additional Inherited Members | |
Protected Member Functions inherited from subModelBase | |
bool | inLine () const |
Flag to indicate whether data is/was read in-line. 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... | |
Templated patch interaction model class.
Definition at line 56 of file PatchInteractionModel.H.
enum interactionType |
Enumerator | |
---|---|
itNone | |
itRebound | |
itStick | |
itEscape | |
itOther |
Definition at line 65 of file PatchInteractionModel.H.
PatchInteractionModel | ( | CloudType & | owner | ) |
Construct null from owner.
Definition at line 116 of file PatchInteractionModel.C.
PatchInteractionModel | ( | const dictionary & | dict, |
CloudType & | owner, | ||
const word & | type | ||
) |
Construct from components.
Definition at line 127 of file PatchInteractionModel.C.
PatchInteractionModel | ( | const PatchInteractionModel< CloudType > & | pim | ) |
Construct copy.
Definition at line 140 of file PatchInteractionModel.C.
|
virtual |
Destructor.
Definition at line 153 of file PatchInteractionModel.C.
TypeName | ( | "patchInteractionModel" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | autoPtr | , |
PatchInteractionModel< CloudType > | , | ||
dictionary | , | ||
(const dictionary &dict, CloudType &owner) | , | ||
(dict, owner) | |||
) |
Declare runtime constructor selection table.
|
pure virtual |
Construct and return a clone.
Implemented in StandardWallInteraction< CloudType >, Rebound< CloudType >, NoInteraction< CloudType >, and LocalInteraction< CloudType >.
|
static |
Selector.
Definition at line 32 of file PatchInteractionModelNew.C.
References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, and Foam::nl.
const Foam::word & UName |
Return name of velocity field.
Definition at line 160 of file PatchInteractionModel.C.
|
static |
Convert interaction result to word.
Definition at line 45 of file PatchInteractionModel.C.
|
static |
Convert word to interaction result.
Definition at line 85 of file PatchInteractionModel.C.
Referenced by LocalInteraction< CloudType >::LocalInteraction().
|
pure virtual |
Apply velocity correction.
Returns true if particle remains in same cell
Implemented in StandardWallInteraction< CloudType >, Rebound< CloudType >, NoInteraction< CloudType >, and LocalInteraction< CloudType >.
|
virtual |
Write patch interaction info to stream.
Reimplemented in StandardWallInteraction< CloudType >, and LocalInteraction< CloudType >.
Definition at line 167 of file PatchInteractionModel.C.
|
static |
Definition at line 74 of file PatchInteractionModel.H.