•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Patch interaction specified on a patch-by-patch basis. More...
Public Member Functions | |
| TypeName ("localInteraction") | |
| Runtime type information. More... | |
| LocalInteraction (const dictionary &dict, CloudType &owner) | |
| Construct from dictionary. More... | |
| LocalInteraction (const LocalInteraction< CloudType > &pim) | |
| Construct copy from owner cloud and patch interaction model. More... | |
| virtual autoPtr< PatchInteractionModel< CloudType > > | clone () const |
| Construct and return a clone using supplied owner cloud. More... | |
| virtual | ~LocalInteraction () |
| Destructor. More... | |
| volScalarField & | massEscape () |
| Return access to the massEscape field. More... | |
| volScalarField & | massStick () |
| Return access to the massStick field. More... | |
| virtual bool | correct (typename CloudType::parcelType &p, const polyPatch &pp, bool &keepParticle, const scalar trackFraction, const tetIndices &tetIs) |
| Apply velocity correction. More... | |
| virtual void | info (Ostream &os) |
| Write patch interaction info to stream. More... | |
 Public Member Functions inherited from PatchInteractionModel< CloudType > | |
| 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 | ~PatchInteractionModel () |
| Destructor. More... | |
| const word & | UName () const |
| Return name of velocity field. 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 () |
| 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) | |
| Construct as copy. 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 dependant 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... | |
Additional Inherited Members | |
| Public Types inherited from PatchInteractionModel< CloudType > | |
| enum | interactionType { itRebound, itStick, itEscape, itOther } |
| Public Types inherited from CloudSubModelBase< CloudType > | |
| typedef CloudType | cloudType |
| Type of cloud this model was instantiated for. More... | |
| Static Public Member Functions inherited from PatchInteractionModel< CloudType > | |
| 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 inherited from PatchInteractionModel< CloudType > | |
| static wordList | interactionTypeNames_ |
| 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... | |
Patch interaction specified on a patch-by-patch basis.
Definition at line 47 of file LocalInteraction.H.
| LocalInteraction | ( | const dictionary & | dict, |
| CloudType & | owner | ||
| ) |
Construct from dictionary.
Definition at line 32 of file LocalInteraction.C.
References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::Info, Foam::name(), Foam::nl, and patchi.
| LocalInteraction | ( | const LocalInteraction< CloudType > & | pim | ) |
Construct copy from owner cloud and patch interaction model.
Definition at line 86 of file LocalInteraction.C.
|
virtual |
Destructor.
Definition at line 105 of file LocalInteraction.C.
Referenced by LocalInteraction< CloudType >::clone().
| TypeName | ( | "localInteraction" | ) |
Runtime type information.
|
inlinevirtual |
Construct and return a clone using supplied owner cloud.
Implements PatchInteractionModel< CloudType >.
Definition at line 97 of file LocalInteraction.H.
References LocalInteraction< CloudType >::correct(), LocalInteraction< CloudType >::info(), LocalInteraction< CloudType >::massEscape(), LocalInteraction< CloudType >::massStick(), p, and LocalInteraction< CloudType >::~LocalInteraction().
| Foam::volScalarField & massEscape | ( | ) |
Return access to the massEscape field.
Definition at line 112 of file LocalInteraction.C.
References Foam::dimMass, mesh, Foam::name(), fvMesh::time(), and Time::timeName().
Referenced by LocalInteraction< CloudType >::clone().
| Foam::volScalarField & massStick | ( | ) |
Return access to the massStick field.
Definition at line 141 of file LocalInteraction.C.
References LocalInteraction< CloudType >::correct(), Foam::dimMass, mesh, Foam::name(), fvMesh::time(), and Time::timeName().
Referenced by LocalInteraction< CloudType >::clone().
|
virtual |
Apply velocity correction.
Returns true if particle remains in same cell
Implements PatchInteractionModel< CloudType >.
Definition at line 171 of file LocalInteraction.C.
References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, patchIdentifier::index(), nw, patchi, U, polyPatch::whichFace(), and Foam::Zero.
Referenced by LocalInteraction< CloudType >::clone(), and LocalInteraction< CloudType >::massStick().
|
virtual |
Write patch interaction info to stream.
Reimplemented from PatchInteractionModel< CloudType >.
Definition at line 276 of file LocalInteraction.C.
References forAll, and Foam::nl.
Referenced by LocalInteraction< CloudType >::clone().
1.8.11