volPointInterpolation Class Reference

Interpolate from cell centres to points (vertices) using inverse distance weighting. More...

Inheritance diagram for volPointInterpolation:
Collaboration diagram for volPointInterpolation:

Public Member Functions

 ClassName ("volPointInterpolation")
 
 volPointInterpolation (const fvMesh &)
 Constructor given fvMesh and pointMesh. More...
 
 volPointInterpolation (const volPointInterpolation &)=delete
 Disallow default bitwise copy construction. More...
 
 ~volPointInterpolation ()
 Destructor. More...
 
void updateMesh (const mapPolyMesh &)
 Update mesh topology using the morph engine. More...
 
bool movePoints ()
 Correct weighting factors for moving mesh. More...
 
template<class Type >
tmp< GeometricField< Type, pointPatchField, pointMesh > > interpolate (const GeometricField< Type, fvPatchField, volMesh > &) const
 Interpolate volField using inverse distance weighting. More...
 
template<class Type >
tmp< GeometricField< Type, pointPatchField, pointMesh > > interpolate (const tmp< GeometricField< Type, fvPatchField, volMesh >> &) const
 Interpolate tmp<volField> using inverse distance weighting. More...
 
template<class Type >
tmp< GeometricField< Type, pointPatchField, pointMesh > > interpolate (const GeometricField< Type, fvPatchField, volMesh > &, const wordList &patchFieldTypes) const
 Interpolate volField using inverse distance weighting. More...
 
template<class Type >
tmp< GeometricField< Type, pointPatchField, pointMesh > > interpolate (const tmp< GeometricField< Type, fvPatchField, volMesh >> &, const wordList &patchFieldTypes) const
 Interpolate tmp<volField> using inverse distance weighting. More...
 
template<class Type >
void interpolateInternalField (const GeometricField< Type, fvPatchField, volMesh > &, GeometricField< Type, pointPatchField, pointMesh > &) const
 Interpolate internal field from volField to pointField. More...
 
template<class Type >
void interpolateBoundaryField (const GeometricField< Type, fvPatchField, volMesh > &vf, GeometricField< Type, pointPatchField, pointMesh > &pf) const
 Interpolate boundary field without applying constraints/boundary. More...
 
template<class Type >
void interpolateBoundaryField (const GeometricField< Type, fvPatchField, volMesh > &vf, GeometricField< Type, pointPatchField, pointMesh > &pf, const bool overrideFixedValue) const
 Interpolate boundary with constraints/boundary conditions. More...
 
template<class Type >
void interpolate (const GeometricField< Type, fvPatchField, volMesh > &, GeometricField< Type, pointPatchField, pointMesh > &) const
 Interpolate from volField to pointField. More...
 
template<class Type >
tmp< GeometricField< Type, pointPatchField, pointMesh > > interpolate (const GeometricField< Type, fvPatchField, volMesh > &, const word &name, const bool cache) const
 Interpolate volField using inverse distance weighting. More...
 
void interpolateDisplacement (const volVectorField &, pointVectorField &) const
 Interpolate from volField to pointField. More...
 
void operator= (const volPointInterpolation &)=delete
 Disallow default bitwise assignment. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > flatBoundaryField (const GeometricField< Type, fvPatchField, volMesh > &vf) const
 
template<class Type >
Foam::tmp< Foam::GeometricField< Type, Foam::pointPatchField, Foam::pointMesh > > interpolate (const GeometricField< Type, fvPatchField, volMesh > &vf, const wordList &patchFieldTypes) const
 
template<class Type >
Foam::tmp< Foam::GeometricField< Type, Foam::pointPatchField, Foam::pointMesh > > interpolate (const tmp< GeometricField< Type, fvPatchField, volMesh >> &tvf, const wordList &patchFieldTypes) const
 
template<class Type >
Foam::tmp< Foam::GeometricField< Type, Foam::pointPatchField, Foam::pointMesh > > interpolate (const GeometricField< Type, fvPatchField, volMesh > &vf, const word &name, const bool cache) const
 
template<class Type >
Foam::tmp< Foam::GeometricField< Type, Foam::pointPatchField, Foam::pointMesh > > interpolate (const GeometricField< Type, fvPatchField, volMesh > &vf) const
 
template<class Type >
Foam::tmp< Foam::GeometricField< Type, Foam::pointPatchField, Foam::pointMesh > > interpolate (const tmp< GeometricField< Type, fvPatchField, volMesh >> &tvf) const
 
- Public Member Functions inherited from MeshObject< fvMesh, UpdateableMeshObject, volPointInterpolation >
 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...
 
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 objectPath () const
 Return complete path + 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)
 

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, volPointInterpolation >
static const volPointInterpolationNew (const fvMesh &mesh)
 
static const volPointInterpolationNew (const fvMesh &mesh, const Data1 &d)
 
static const volPointInterpolationNew (const fvMesh &mesh, const Data1 &, const Data2 &)
 
static const volPointInterpolationNew (const fvMesh &mesh, const Data1 &, const Data2 &, const Data3 &)
 
static const volPointInterpolationNew (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 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 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, volPointInterpolation >
const fvMeshmesh_
 

Detailed Description

Interpolate from cell centres to points (vertices) using inverse distance weighting.

Source files

Definition at line 56 of file volPointInterpolation.H.

Constructor & Destructor Documentation

◆ volPointInterpolation() [1/2]

volPointInterpolation ( const fvMesh vm)
explicit

Constructor given fvMesh and pointMesh.

Definition at line 349 of file volPointInterpolation.C.

◆ volPointInterpolation() [2/2]

Disallow default bitwise copy construction.

◆ ~volPointInterpolation()

Destructor.

Definition at line 359 of file volPointInterpolation.C.

Member Function Documentation

◆ ClassName()

ClassName ( "volPointInterpolation"  )

◆ updateMesh()

void updateMesh ( const mapPolyMesh )
virtual

Update mesh topology using the morph engine.

Implements UpdateableMeshObject< fvMesh >.

Definition at line 365 of file volPointInterpolation.C.

◆ movePoints()

bool movePoints ( )
virtual

Correct weighting factors for moving mesh.

Implements MoveableMeshObject< fvMesh >.

Definition at line 371 of file volPointInterpolation.C.

References volPointInterpolation::interpolateDisplacement().

Here is the call graph for this function:

◆ interpolate() [1/11]

◆ interpolate() [2/11]

tmp<GeometricField<Type, pointPatchField, pointMesh> > interpolate ( const tmp< GeometricField< Type, fvPatchField, volMesh >> &  ) const

Interpolate tmp<volField> using inverse distance weighting.

returning pointField

◆ interpolate() [3/11]

tmp<GeometricField<Type, pointPatchField, pointMesh> > interpolate ( const GeometricField< Type, fvPatchField, volMesh > &  ,
const wordList patchFieldTypes 
) const

Interpolate volField using inverse distance weighting.

returning pointField with the same patchField types. Assigns to any fixedValue boundary conditions to make them consistent with internal field

◆ interpolate() [4/11]

tmp<GeometricField<Type, pointPatchField, pointMesh> > interpolate ( const tmp< GeometricField< Type, fvPatchField, volMesh >> &  ,
const wordList patchFieldTypes 
) const

Interpolate tmp<volField> using inverse distance weighting.

returning pointField with the same patchField types. Assigns to any fixedValue boundary conditions to make them consistent with internal field

◆ interpolateInternalField()

void interpolateInternalField ( const GeometricField< Type, fvPatchField, volMesh > &  vf,
GeometricField< Type, pointPatchField, pointMesh > &  pf 
) const

Interpolate internal field from volField to pointField.

using inverse distance weighting

Definition at line 128 of file volPointInterpolate.C.

References Foam::endl(), forAll, DimensionedField< Type, GeoMesh >::mesh(), Foam::Pout, and Foam::Zero.

Referenced by volPointInterpolation::interpolate(), and volPointInterpolation::interpolateDisplacement().

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

◆ interpolateBoundaryField() [1/2]

◆ interpolateBoundaryField() [2/2]

void interpolateBoundaryField ( const GeometricField< Type, fvPatchField, volMesh > &  vf,
GeometricField< Type, pointPatchField, pointMesh > &  pf,
const bool  overrideFixedValue 
) const

◆ interpolate() [5/11]

void interpolate ( const GeometricField< Type, fvPatchField, volMesh > &  vf,
GeometricField< Type, pointPatchField, pointMesh > &  pf 
) const

Interpolate from volField to pointField.

using inverse distance weighting

Definition at line 348 of file volPointInterpolate.C.

References Foam::endl(), volPointInterpolation::interpolate(), volPointInterpolation::interpolateBoundaryField(), volPointInterpolation::interpolateInternalField(), and Foam::Pout.

Here is the call graph for this function:

◆ interpolate() [6/11]

tmp<GeometricField<Type, pointPatchField, pointMesh> > interpolate ( const GeometricField< Type, fvPatchField, volMesh > &  ,
const word name,
const bool  cache 
) const

Interpolate volField using inverse distance weighting.

returning pointField with name. Optionally caches

◆ interpolateDisplacement()

void interpolateDisplacement ( const volVectorField vf,
pointVectorField pf 
) const

Interpolate from volField to pointField.

using inverse distance weighting

Definition at line 380 of file volPointInterpolation.C.

References pointConstraints::constrainDisplacement(), volPointInterpolation::interpolateBoundaryField(), volPointInterpolation::interpolateInternalField(), DimensionedField< Type, GeoMesh >::mesh(), and MeshObject< pointMesh, UpdateableMeshObject, pointConstraints >::New().

Referenced by volPointInterpolation::movePoints().

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

◆ operator=()

void operator= ( const volPointInterpolation )
delete

Disallow default bitwise assignment.

◆ flatBoundaryField()

◆ interpolate() [7/11]

◆ interpolate() [8/11]

Foam::tmp<Foam::GeometricField<Type, Foam::pointPatchField, Foam::pointMesh> > interpolate ( const tmp< GeometricField< Type, fvPatchField, volMesh >> &  tvf,
const wordList patchFieldTypes 
) const

Definition at line 408 of file volPointInterpolate.C.

References volPointInterpolation::interpolate().

Here is the call graph for this function:

◆ interpolate() [9/11]

◆ interpolate() [10/11]

Definition at line 521 of file volPointInterpolate.C.

References volPointInterpolation::interpolate(), and IOobject::name().

Here is the call graph for this function:

◆ interpolate() [11/11]

Definition at line 532 of file volPointInterpolate.C.

References volPointInterpolation::interpolate().

Here is the call graph for this function:

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