Wall interaction model. More...
Public Member Functions | |
TypeName ("standardWallInteraction") | |
Runtime type information. More... | |
StandardWallInteraction (const dictionary &dict, CloudType &cloud) | |
Construct from dictionary. More... | |
StandardWallInteraction (const StandardWallInteraction< 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 | ~StandardWallInteraction ()=default |
Destructor. More... | |
virtual bool | correct (typename CloudType::parcelType &p, const polyPatch &pp, bool &keepParticle) |
Apply velocity correction. More... | |
virtual void | info () |
Write patch interaction info. 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 ()=default |
Destructor. More... | |
const word & | UName () const |
Return name of velocity field. More... | |
const scalar & | Urmax () const |
Return Urmax. More... | |
virtual void | addToEscapedParcels (const scalar mass) |
Add to escaped parcels. More... | |
virtual void | postEvolve () |
Post-evolve hook. 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 | 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... | |
Public Member Functions inherited from writeFile | |
writeFile (const objectRegistry &obr, const fileName &prefix, const word &name="undefined", const bool writeToFile=true) | |
Construct from objectRegistry, prefix, fileName. More... | |
writeFile (const objectRegistry &obr, const fileName &prefix, const word &name, const dictionary &dict, const bool writeToFile=true) | |
Construct from objectRegistry, prefix, fileName and read options from dictionary. More... | |
writeFile (const writeFile &wf) | |
Construct copy. More... | |
virtual | ~writeFile ()=default |
Destructor. More... | |
virtual bool | read (const dictionary &dict) |
Read. More... | |
virtual OFstream & | file () |
Return access to the file (if only 1) More... | |
virtual bool | writeToFile () const |
Flag to allow writing to file. More... | |
virtual bool | canWriteToFile () const |
Flag to allow writing to the file. More... | |
virtual bool | canResetFile () const |
Flag to allow resetting the file. More... | |
virtual bool | canWriteHeader () const |
Flag to allow writing the header. More... | |
virtual label | charWidth () const |
Return width of character stream output. More... | |
virtual void | writeCommented (Ostream &os, const string &str) const |
Write a commented string to stream. More... | |
virtual void | writeTabbed (Ostream &os, const string &str) const |
Write a tabbed string to stream. More... | |
virtual void | writeHeader (Ostream &os, const string &str) const |
Write a commented header to stream. More... | |
virtual void | writeCurrentTime (Ostream &os) const |
Write the current time to stream. More... | |
virtual void | writeBreak (Ostream &os) const |
Write a break marker to the stream. More... | |
template<class Type > | |
void | writeHeaderValue (Ostream &os, const string &property, const Type &value) const |
Write a (commented) header property and value pair. More... | |
template<class Type > | |
void | writeValue (Ostream &os, const Type &val) const |
Write a given value to stream with the space delimiter. More... | |
Protected Member Functions | |
virtual void | writeFileHeader (Ostream &os) |
Output file header information. More... | |
Protected Member Functions inherited from subModelBase | |
bool | inLine () const |
Flag to indicate whether data is/was read in-line. More... | |
Protected Member Functions inherited from writeFile | |
void | initStream (Ostream &os) const |
Initialise the output stream for writing. More... | |
fileName | baseFileDir () const |
Return the base directory for output. More... | |
fileName | baseTimeDir () const |
Return the base directory for the current time value. More... | |
fileName | filePath (const fileName &fName) const |
Return the full path for the supplied file name. More... | |
virtual autoPtr< OFstream > | newFile (const fileName &fName) const |
Return autoPtr to a new file using file name. More... | |
virtual autoPtr< OFstream > | newFileAtTime (const word &name, scalar timeValue) const |
Return autoPtr to a new file for a given time. More... | |
virtual autoPtr< OFstream > | newFileAtStartTime (const word &name) const |
Return autoPtr to a new file using the simulation start time. More... | |
virtual void | resetFile (const word &name) |
Reset internal file pointer to new file with new name. More... | |
Omanip< int > | valueWidth (const label offset=0) const |
Return the value width when writing to stream with optional offset. More... | |
void | operator= (const writeFile &)=delete |
No copy assignment. More... | |
virtual autoPtr< OFstream > | createFile (const word &name, scalar timeValue) const |
Deprecated(2022-09) Return autoPtr to a new file for a given time. More... | |
virtual autoPtr< OFstream > | createFile (const word &name) const |
Deprecated(2022-09) Return autoPtr to a new file using the simulation start time. More... | |
Protected Attributes | |
const fvMesh & | mesh_ |
PatchInteractionModel< CloudType >::interactionType | interactionType_ |
Interaction type. More... | |
scalar | e_ |
Elasticity coefficient. More... | |
scalar | mu_ |
Restitution coefficient. More... | |
List< List< label > > | nEscape_ |
Number of parcels escaped. More... | |
List< List< scalar > > | massEscape_ |
Mass of parcels escaped. More... | |
List< List< label > > | nStick_ |
Number of parcels stuck to patches. More... | |
List< List< scalar > > | massStick_ |
Mass of parcels stuck to patches. More... | |
bool | outputByInjectorId_ |
Flag to output escaped/mass particles sorted by injectorID. More... | |
Map< label > | injIdToIndex_ |
InjectorId to index map, when outputting escaped/stick/... More... | |
Protected Attributes inherited from PatchInteractionModel< CloudType > | |
const word | UName_ |
Name of velocity field - default = "U". More... | |
label | escapedParcels_ |
Number of parcels escaped. More... | |
scalar | escapedMass_ |
Mass of parcels escaped. More... | |
scalar | Urmax_ |
Maximum relative U with patch for particle to be removed. 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... | |
Protected Attributes inherited from writeFile | |
const objectRegistry & | fileObr_ |
Reference to the region objectRegistry. More... | |
const fileName | prefix_ |
Prefix. More... | |
word | fileName_ |
Name of file. More... | |
autoPtr< OFstream > | filePtr_ |
File pointer. More... | |
label | writePrecision_ |
Write precision. More... | |
bool | writeToFile_ |
Flag to enable/disable writing to file. More... | |
bool | updateHeader_ |
Flag to update the header, e.g. on mesh changes. Default is true. More... | |
bool | writtenHeader_ |
Flag to identify whether the header has been written. More... | |
bool | useUserTime_ |
Flag to use the specified user time, e.g. CA deg instead of seconds. Default = true. More... | |
scalar | startTime_ |
Start time value. More... | |
Additional Inherited Members | |
Public Types inherited from PatchInteractionModel< CloudType > | |
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... | |
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... | |
Public Attributes inherited from subModelBase | |
bool | log |
Flag to write log into Info. More... | |
Static Public Attributes inherited from PatchInteractionModel< CloudType > | |
static wordList | interactionTypeNames_ |
Static Public Attributes inherited from writeFile | |
static label | addChars = 8 |
Additional characters for writing. More... | |
Wall interaction model.
Example usage:
StandardWallInteractionCoeffs { type rebound; // stick, escape e 1; // optional - elasticity coeff mu 0; // optional - restitution coeff }
Definition at line 60 of file StandardWallInteraction.H.
StandardWallInteraction | ( | const dictionary & | dict, |
CloudType & | cloud | ||
) |
Construct from dictionary.
Definition at line 51 of file StandardWallInteraction.C.
References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, and Foam::Zero.
StandardWallInteraction | ( | const StandardWallInteraction< CloudType > & | pim | ) |
Construct copy from owner cloud and patch interaction model.
Definition at line 125 of file StandardWallInteraction.C.
|
virtualdefault |
Destructor.
|
protectedvirtual |
Output file header information.
Reimplemented from PatchInteractionModel< CloudType >.
Definition at line 27 of file StandardWallInteraction.C.
References forAll, Foam::name(), and os().
TypeName | ( | "standardWallInteraction" | ) |
Runtime type information.
|
inlinevirtual |
Construct and return a clone using supplied owner cloud.
Implements PatchInteractionModel< CloudType >.
Definition at line 155 of file StandardWallInteraction.H.
|
virtual |
Apply velocity correction.
Returns true if particle remains in same cell
Implements PatchInteractionModel< CloudType >.
Definition at line 146 of file StandardWallInteraction.C.
References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::mag(), Foam::nl, p, pp(), U, WarningInFunction, and Foam::Zero.
|
virtual |
Write patch interaction info.
Reimplemented from PatchInteractionModel< CloudType >.
Definition at line 253 of file StandardWallInteraction.C.
References Foam::endl(), forAll, forAllConstIters(), Log_, Foam::nl, Foam::tab, and Foam::Zero.
|
protected |
Definition at line 69 of file StandardWallInteraction.H.
|
protected |
Interaction type.
Definition at line 75 of file StandardWallInteraction.H.
|
protected |
Elasticity coefficient.
Definition at line 80 of file StandardWallInteraction.H.
|
protected |
Restitution coefficient.
Definition at line 85 of file StandardWallInteraction.H.
Number of parcels escaped.
Definition at line 93 of file StandardWallInteraction.H.
Mass of parcels escaped.
Definition at line 98 of file StandardWallInteraction.H.
Number of parcels stuck to patches.
Definition at line 103 of file StandardWallInteraction.H.
Mass of parcels stuck to patches.
Definition at line 108 of file StandardWallInteraction.H.
|
protected |
Flag to output escaped/mass particles sorted by injectorID.
Definition at line 114 of file StandardWallInteraction.H.
|
protected |
InjectorId to index map, when outputting escaped/stick/...
particles sorted by injectorID
Definition at line 121 of file StandardWallInteraction.H.
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.