All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
wallDist Class Reference

Interface to run-time selectable methods to calculate the distance-to-wall and normal-to-wall fields. More...

Inheritance diagram for wallDist:
Collaboration diagram for wallDist:

Public Member Functions

 ClassName ("wallDist")
 
 wallDist (const fvMesh &mesh, const word &patchTypeName="wall")
 Construct from mesh and optional patch type name. More...
 
 wallDist (const fvMesh &mesh, const labelHashSet &patchIDs, const word &patchTypeName="patch")
 Construct from mesh, patch IDs and optional patch type name. More...
 
 wallDist (const wallDist &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~wallDist ()
 Destructor. More...
 
const labelHashSetpatchIDs () const
 Return the patchIDs. More...
 
const volScalarFieldy () const
 Return reference to cached distance-to-wall field. More...
 
const volVectorFieldn () const
 Return reference to cached normal-to-wall field. More...
 
virtual bool movePoints ()
 Update the y-field when the mesh moves. More...
 
virtual void updateMesh (const mapPolyMesh &)
 Update the y-field when the mesh changes. More...
 
void operator= (const wallDist &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from MeshObject< fvMesh, UpdateableMeshObject, wallDist >
 MeshObject (const fvMesh &mesh)
 
virtual ~MeshObject ()
 
const fvMeshmesh () const
 
virtual bool writeData (Foam::Ostream &) const
 
- Public Member Functions inherited from UpdateableMeshObject< fvMesh >
 UpdateableMeshObject (const word &typeName, const objectRegistry &obr)
 
- Public Member Functions inherited from MoveableMeshObject< fvMesh >
 MoveableMeshObject (const word &typeName, const objectRegistry &obr)
 
- Public Member Functions inherited from GeometricMeshObject< fvMesh >
 GeometricMeshObject (const word &typeName, const objectRegistry &obr)
 
- Public Member Functions inherited from TopologicalMeshObject< fvMesh >
 TopologicalMeshObject (const word &typeName, const objectRegistry &obr)
 
- Public Member Functions inherited from meshObject
 ClassName ("meshObject")
 
 meshObject (const word &typeName, const objectRegistry &obr)
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the. More...
 
 regIOobject (const regIOobject &)
 Copy constructor. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Copy constructor, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Copy constructor with new name, transferring registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Copy constructor with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
virtual void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
void store ()
 Transfer ownership of this object to its registry. More...
 
void release ()
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
labeleventNo ()
 Event number at last update. More...
 
bool upToDate (const regIOobject &) const
 Return true if up-to-date with respect to given object. More...
 
bool upToDate (const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
void setUpToDate ()
 Set up to date (obviously) More...
 
virtual void rename (const word &newName)
 Rename. More...
 
virtual fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool read=true)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual bool readData (Istream &)
 Virtual readData function. More...
 
virtual bool read ()
 Read object. More...
 
virtual label addWatch (const fileName &)
 Add file watch for fileName on object if not yet watched. Return. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool global () const
 Is object same for all processors. More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
 Write using given format, version and compression. More...
 
virtual bool write (const bool write=true) const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Construct from copy resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Construct from copy resetting name. More...
 
 IOobject (const IOobject &io)=default
 Copy constructor. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () const
 Return the optional note. More...
 
bool & registerObject ()
 Register object created from this IOobject with registry if true. More...
 
bool registerObject () const
 Register object created from this IOobject with registry if true. More...
 
readOption readOpt () const
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
word modelName (const char *name) const
 Return the name of the object within this model. More...
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () const
 
fileName path () const
 Return complete path. More...
 
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local. More...
 
fileName localPath () const
 Return the path relative to the case. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName localObjectPath () const
 Return complete localPath + object name. More...
 
fileName localFilePath (const word &typeName) const
 Helper for filePath that searches locally. More...
 
fileName globalFilePath (const word &typeName) const
 Helper for filePath that searches up if in parallel. More...
 
bool readHeader (Istream &)
 Read header. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType=true)
 Read header (uses typeFilePath to find file) and check header. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &) const
 Write header. More...
 
bool writeHeader (Ostream &, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
template<class Name >
Foam::word modelName (Name name, const word &model)
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  objectState { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Static Public Member Functions inherited from MeshObject< fvMesh, UpdateableMeshObject, wallDist >
static const wallDistNew (const fvMesh &mesh)
 
static const wallDistNew (const fvMesh &mesh, const Data1 &d)
 
static const wallDistNew (const fvMesh &mesh, const Data1 &, const Data2 &)
 
static const wallDistNew (const fvMesh &mesh, const Data1 &, const Data2 &, const Data3 &)
 
static const wallDistNew (const fvMesh &mesh, const Data1 &, const Data2 &, const Data3 &, const Data4 &)
 
static bool Delete (const fvMesh &mesh)
 
- Static Public Member Functions inherited from meshObject
template<class Mesh >
static void movePoints (objectRegistry &)
 
template<class Mesh >
static void updateMesh (objectRegistry &, const mapPolyMesh &)
 
template<class Mesh >
static void addPatch (objectRegistry &, const label patchi)
 
template<class Mesh >
static void reorderPatches (objectRegistry &, const labelUList &newToOld, const bool validBoundary)
 
template<class Mesh , template< class > class MeshObjectType>
static void clear (objectRegistry &)
 
template<class Mesh , template< class > class FromType, template< class > class ToType>
static void clearUpto (objectRegistry &)
 Clear all meshObject derived from FromType up to (but not including) More...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class Name >
static word groupName (Name name, const word &group)
 
static word group (const word &name)
 Return group (extension part of name) More...
 
static word member (const word &name)
 Return member (name without the extension) More...
 
template<class Name >
static word modelName (Name name, const word &model)
 Return the name of the object within the given model. More...
 
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider. More...
 
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider. More...
 
- Static Public Attributes inherited from regIOobject
static float fileModificationSkew
 
- Static Public Attributes inherited from IOobject
static constexpr const char * foamFile = "FoamFile"
 Keyword for the FoamFile header sub-dictionary. More...
 
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName)
 Helper: check readOpt flags and read if necessary. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &)
 Set the object state to bad. More...
 
- Protected Attributes inherited from MeshObject< fvMesh, UpdateableMeshObject, wallDist >
const fvMeshmesh_
 

Detailed Description

Interface to run-time selectable methods to calculate the distance-to-wall and normal-to-wall fields.

Example of the wallDist specification in fvSchemes:

    wallDist
    {
        method meshWave;

        // Optional entry enabling the calculation
        // of the normal-to-wall field
        nRequired false;
    }
See also
Foam::patchDistMethod::meshWave Foam::patchDistMethod::Poisson Foam::patchDistMethod::advectionDiffusion
Source files

Definition at line 68 of file wallDist.H.

Constructor & Destructor Documentation

◆ wallDist() [1/3]

wallDist ( const fvMesh mesh,
const word patchTypeName = "wall" 
)

Construct from mesh and optional patch type name.

Definition at line 63 of file wallDist.C.

References wallDist::movePoints().

Here is the call graph for this function:

◆ wallDist() [2/3]

wallDist ( const fvMesh mesh,
const labelHashSet patchIDs,
const word patchTypeName = "patch" 
)

Construct from mesh, patch IDs and optional patch type name.

Definition at line 107 of file wallDist.C.

References wallDist::movePoints().

Here is the call graph for this function:

◆ wallDist() [3/3]

wallDist ( const wallDist )
delete

Disallow default bitwise copy construction.

◆ ~wallDist()

~wallDist ( )
virtual

Destructor.

Definition at line 156 of file wallDist.C.

Member Function Documentation

◆ ClassName()

ClassName ( "wallDist"  )

◆ patchIDs()

const labelHashSet& patchIDs ( ) const
inline

Return the patchIDs.

Definition at line 133 of file wallDist.H.

◆ y()

const volScalarField& y ( ) const
inline

Return reference to cached distance-to-wall field.

Definition at line 139 of file wallDist.H.

References wallDist::movePoints(), wallDist::n(), wallDist::operator=(), and wallDist::updateMesh().

Here is the call graph for this function:

◆ n()

const Foam::volVectorField & n ( ) const

Return reference to cached normal-to-wall field.

Definition at line 162 of file wallDist.C.

References Foam::endl(), Foam::isNull(), Foam::nl, and WarningInFunction.

Referenced by wallDist::y().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ movePoints()

bool movePoints ( )
virtual

Update the y-field when the mesh moves.

Implements MoveableMeshObject< fvMesh >.

Definition at line 180 of file wallDist.C.

Referenced by wallDist::updateMesh(), wallDist::wallDist(), and wallDist::y().

Here is the caller graph for this function:

◆ updateMesh()

void updateMesh ( const mapPolyMesh mpm)
virtual

Update the y-field when the mesh changes.

Implements UpdateableMeshObject< fvMesh >.

Definition at line 200 of file wallDist.C.

References wallDist::movePoints().

Referenced by wallDist::y().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=()

void operator= ( const wallDist )
delete

Disallow default bitwise assignment.

Referenced by wallDist::y().

Here is the caller graph for this function:

The documentation for this class was generated from the following files: