sampledSurface Class Referenceabstract

An abstract class for surfaces with sampling. More...

Inheritance diagram for sampledSurface:

Classes

class  iNew
 Class used for the PtrLists read-construction. More...
 

Public Member Functions

 TypeName ("sampledSurface")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, sampledSurface, word,(const word &name, const polyMesh &mesh, const dictionary &dict),(name, mesh, dict))
 Declare run-time constructor selection table. More...
 
 sampledSurface (const word &name, const polyMesh &, const bool interpolate=false)
 Construct from name, mesh. More...
 
 sampledSurface (const word &name, const polyMesh &, const dictionary &)
 Construct from dictionary. More...
 
autoPtr< sampledSurfaceclone () const
 Clone. More...
 
virtual ~sampledSurface ()
 Destructor. More...
 
const polyMeshmesh () const
 Access to the underlying mesh. More...
 
const wordname () const
 Name of surface. More...
 
bool interpolate () const
 Interpolation requested for surface. More...
 
virtual bool needsUpdate () const =0
 Does the surface need an update? More...
 
virtual wordList fields () const
 Return the list of fields required. More...
 
virtual bool expire ()=0
 Mark the surface as needing an update. More...
 
virtual bool update ()=0
 Update the surface as required. More...
 
virtual const pointFieldpoints () const =0
 Points of surface. More...
 
virtual const faceListfaces () const =0
 Faces of surface. More...
 
virtual const vectorFieldSf () const
 Return face area vectors. More...
 
virtual const scalarFieldmagSf () const
 Return face area magnitudes. More...
 
virtual const vectorFieldCf () const
 Return face centres as vectorField. More...
 
scalar area () const
 The total surface area. More...
 
template<class Type >
Type integrate (const Field< Type > &) const
 Integration of a field across the surface. More...
 
template<class Type >
Type integrate (const tmp< Field< Type >> &) const
 Integration of a field across the surface. More...
 
template<class Type >
Type average (const Field< Type > &) const
 Area-averaged value of a field across the surface. More...
 
template<class Type >
Type average (const tmp< Field< Type >> &) const
 Area-averaged value of a field across the surface. More...
 
tmp< Field< scalar > > project (const Field< scalar > &) const
 Project field onto surface. More...
 
tmp< Field< scalar > > project (const Field< vector > &) const
 Project field onto surface. More...
 
tmp< Field< vector > > project (const Field< sphericalTensor > &) const
 Project field onto surface. More...
 
tmp< Field< vector > > project (const Field< symmTensor > &) const
 Project field onto surface. More...
 
tmp< Field< vector > > project (const Field< tensor > &) const
 Project field onto surface. More...
 
template<class Type >
tmp< GeometricField< Type, fvPatchField, volMesh > > pointAverage (const GeometricField< Type, pointPatchField, pointMesh > &pfld) const
 Interpolate from points to cell centre. More...
 
virtual tmp< scalarFieldsample (const volScalarField &) const =0
 Sample field on surface. More...
 
virtual tmp< vectorFieldsample (const volVectorField &) const =0
 Sample field on surface. More...
 
virtual tmp< sphericalTensorFieldsample (const volSphericalTensorField &) const =0
 Sample field on surface. More...
 
virtual tmp< symmTensorFieldsample (const volSymmTensorField &) const =0
 Sample field on surface. More...
 
virtual tmp< tensorFieldsample (const volTensorField &) const =0
 Sample field on surface. More...
 
virtual tmp< scalarFieldsample (const surfaceScalarField &) const
 Surface sample field on surface. More...
 
virtual tmp< vectorFieldsample (const surfaceVectorField &) const
 Surface Sample field on surface. More...
 
virtual tmp< sphericalTensorFieldsample (const surfaceSphericalTensorField &) const
 Surface sample field on surface. More...
 
virtual tmp< symmTensorFieldsample (const surfaceSymmTensorField &) const
 Surface sample field on surface. More...
 
virtual tmp< tensorFieldsample (const surfaceTensorField &) const
 Surface sample field on surface. More...
 
virtual tmp< scalarFieldinterpolate (const interpolation< scalar > &) const =0
 Interpolate field on surface. More...
 
virtual tmp< vectorFieldinterpolate (const interpolation< vector > &) const =0
 Interpolate field on surface. More...
 
virtual tmp< sphericalTensorFieldinterpolate (const interpolation< sphericalTensor > &) const =0
 Interpolate field on surface. More...
 
virtual tmp< symmTensorFieldinterpolate (const interpolation< symmTensor > &) const =0
 Interpolate field on surface. More...
 
virtual tmp< tensorFieldinterpolate (const interpolation< tensor > &) const =0
 Interpolate field on surface. More...
 
virtual void rename (const word &newName)
 Rename. More...
 
virtual void print (Ostream &) const
 Write. More...
 
template<class ReturnType , class Type >
Foam::tmp< Foam::Field< ReturnType > > project (const tmp< Field< Type >> &field) const
 
template<class Type >
Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > > pointAverage (const GeometricField< Type, pointPatchField, pointMesh > &pfld) const
 

Static Public Member Functions

static autoPtr< sampledSurfaceNew (const word &name, const polyMesh &, const dictionary &)
 Return a reference to the selected surface. More...
 

Protected Member Functions

virtual void clearGeom () const
 

Friends

Ostreamoperator<< (Ostream &, const sampledSurface &)
 Ostream operator. More...
 

Detailed Description

An abstract class for surfaces with sampling.

The constructors for the derived classes should generally start in a 'expired' condition (ie, needsUpdate() == true) and rely on a subsequent call to the update() method to complete the initialisation. Delaying the final construction as late as possible allows the construction of surfaces that may depend on intermediate calculation results (eg, iso-surfaces) and also avoids the unnecessary reconstruction of surfaces between sampling intervals.

It is the responsibility of the caller to ensure that the surface update() is called before the surface is used. The update() method implementation should do nothing when the surface is already up-to-date.

Source files

Definition at line 81 of file sampledSurface.H.

Constructor & Destructor Documentation

◆ sampledSurface() [1/2]

sampledSurface ( const word name,
const polyMesh mesh,
const bool  interpolate = false 
)

Construct from name, mesh.

Definition at line 150 of file sampledSurface.C.

Referenced by sampledSurface::New(), and sampledSurface::iNew::operator()().

Here is the caller graph for this function:

◆ sampledSurface() [2/2]

sampledSurface ( const word name,
const polyMesh mesh,
const dictionary dict 
)

Construct from dictionary.

Definition at line 167 of file sampledSurface.C.

References dictionary::readIfPresent().

Here is the call graph for this function:

◆ ~sampledSurface()

~sampledSurface ( )
virtual

Destructor.

Definition at line 187 of file sampledSurface.C.

Referenced by sampledSurface::clone().

Here is the caller graph for this function:

Member Function Documentation

◆ clearGeom()

void clearGeom ( ) const
protectedvirtual

Definition at line 105 of file sampledSurface.C.

References Foam::deleteDemandDrivenData(), and sampledSurface::New().

Referenced by plane::expire(), isoSurface::expire(), patch::expire(), triSurfaceMesh::expire(), and plane::update().

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

◆ TypeName()

TypeName ( "sampledSurface"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
sampledSurface  ,
word  ,
(const word &name, const polyMesh &mesh, const dictionary &dict ,
(name, mesh, dict  
)

Declare run-time constructor selection table.

◆ clone()

autoPtr<sampledSurface> clone ( ) const
inline

Clone.

Definition at line 221 of file sampledSurface.H.

References sampledSurface::New(), NotImplemented, and sampledSurface::~sampledSurface().

Here is the call graph for this function:

◆ New()

Foam::autoPtr< Foam::sampledSurface > New ( const word name,
const polyMesh mesh,
const dictionary dict 
)
static

Return a reference to the selected surface.

Definition at line 117 of file sampledSurface.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, dictionary::lookup(), mesh, Foam::name(), Foam::nl, and sampledSurface::sampledSurface().

Referenced by sampledSurface::clearGeom(), sampledSurface::clone(), NamedEnum< compressibleField, 8 >::names(), and sampledSurface::iNew::operator()().

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

◆ mesh()

const polyMesh& mesh ( ) const
inline

Access to the underlying mesh.

Definition at line 248 of file sampledSurface.H.

Referenced by patch::patchFaceLabels(), and sampledSurface::pointAverage().

Here is the caller graph for this function:

◆ name()

const word& name ( ) const
inline

Name of surface.

Definition at line 254 of file sampledSurface.H.

Referenced by sampledSurface::iNew::operator()(), patch::patchFaceLabels(), and sampledSurfaces::write().

Here is the caller graph for this function:

◆ interpolate() [1/6]

◆ needsUpdate()

virtual bool needsUpdate ( ) const
pure virtual

Does the surface need an update?

Implemented in triSurfaceMesh, patch, distanceSurface, cuttingPlane, thresholdCellFaces, isoSurface, and plane.

Referenced by sampledSurface::interpolate().

Here is the caller graph for this function:

◆ fields()

◆ expire()

virtual bool expire ( )
pure virtual

Mark the surface as needing an update.

May also free up unneeded data. Return false if surface was already marked as expired.

Implemented in triSurfaceMesh, patch, distanceSurface, cuttingPlane, thresholdCellFaces, isoSurface, and plane.

Referenced by sampledSurface::fields().

Here is the caller graph for this function:

◆ update()

virtual bool update ( )
pure virtual

Update the surface as required.

Do nothing (and return false) if no update was required

Implemented in triSurfaceMesh, patch, distanceSurface, cuttingPlane, thresholdCellFaces, isoSurface, and plane.

Referenced by sampledSurface::fields(), and sampledSurfaces::update().

Here is the caller graph for this function:

◆ points()

virtual const pointField& points ( ) const
pure virtual

◆ faces()

virtual const faceList& faces ( ) const
pure virtual

◆ Sf()

const Foam::vectorField & Sf ( ) const
virtual

Return face area vectors.

Definition at line 195 of file sampledSurface.C.

Referenced by sampledSurface::average(), and sampledSurface::fields().

Here is the caller graph for this function:

◆ magSf()

const Foam::scalarField & magSf ( ) const
virtual

Return face area magnitudes.

Definition at line 206 of file sampledSurface.C.

Referenced by sampledSurface::average(), sampledSurface::fields(), and sampledSurface::integrate().

Here is the caller graph for this function:

◆ Cf()

const Foam::vectorField & Cf ( ) const
virtual

Return face centres as vectorField.

Definition at line 217 of file sampledSurface.C.

Referenced by sampledSurface::fields().

Here is the caller graph for this function:

◆ area()

Foam::scalar area ( ) const

The total surface area.

Definition at line 228 of file sampledSurface.C.

References Foam::reduce(), sampledSurface::sample(), and Foam::sum().

Referenced by sampledSurface::average(), and sampledSurface::fields().

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

◆ integrate() [1/2]

Type integrate ( const Field< Type > &  field) const

Integration of a field across the surface.

Definition at line 52 of file sampledSurfaceTemplates.C.

References sampledSurface::magSf(), Foam::reduce(), Foam::sum(), and Foam::Zero.

Referenced by sampledSurface::fields(), and sampledSurface::integrate().

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

◆ integrate() [2/2]

Type integrate ( const tmp< Field< Type >> &  field) const

Integration of a field across the surface.

Definition at line 67 of file sampledSurfaceTemplates.C.

References field(), and sampledSurface::integrate().

Here is the call graph for this function:

◆ average() [1/2]

Type average ( const Field< Type > &  field) const

Area-averaged value of a field across the surface.

Definition at line 76 of file sampledSurfaceTemplates.C.

References sampledSurface::area(), sampledSurface::magSf(), Foam::reduce(), Foam::sum(), and Foam::Zero.

Referenced by sampledSurface::average(), and sampledSurface::fields().

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

◆ average() [2/2]

Type average ( const tmp< Field< Type >> &  field) const

Area-averaged value of a field across the surface.

Definition at line 100 of file sampledSurfaceTemplates.C.

References sampledSurface::average(), List< Type >::clear(), field(), forAll, Foam::mag(), and sampledSurface::Sf().

Here is the call graph for this function:

◆ project() [1/6]

Foam::tmp< Foam::Field< Foam::scalar > > project ( const Field< scalar > &  field) const

Project field onto surface.

Definition at line 291 of file sampledSurface.C.

References forAll, and tmp< T >::ref().

Here is the call graph for this function:

◆ project() [2/6]

Foam::tmp< Foam::Field< Foam::scalar > > project ( const Field< vector > &  field) const

Project field onto surface.

Definition at line 306 of file sampledSurface.C.

References field(), and tmp< T >::ref().

Here is the call graph for this function:

◆ project() [3/6]

Foam::tmp< Foam::Field< Foam::vector > > project ( const Field< sphericalTensor > &  field) const

Project field onto surface.

Definition at line 315 of file sampledSurface.C.

References field(), and tmp< T >::ref().

Here is the call graph for this function:

◆ project() [4/6]

Foam::tmp< Foam::Field< Foam::vector > > project ( const Field< symmTensor > &  field) const

Project field onto surface.

Definition at line 324 of file sampledSurface.C.

References field(), sampledSurface::project(), and tmp< T >::ref().

Referenced by sampledSurface::project().

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

◆ project() [5/6]

Foam::tmp< Foam::Field< Foam::vector > > project ( const Field< tensor > &  field) const

Project field onto surface.

Definition at line 333 of file sampledSurface.C.

References field(), and tmp< T >::ref().

Here is the call graph for this function:

◆ pointAverage() [1/2]

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

Interpolate from points to cell centre.

Referenced by sampledSurface::fields(), and sampledSurface::project().

Here is the caller graph for this function:

◆ sample() [1/10]

virtual tmp<scalarField> sample ( const volScalarField ) const
pure virtual

Sample field on surface.

Implemented in triSurfaceMesh, patch, distanceSurface, cuttingPlane, thresholdCellFaces, isoSurface, plane, and patchInternalField.

Referenced by sampledSurface::area(), sampledSurface::fields(), and sampledSurface::sample().

Here is the caller graph for this function:

◆ sample() [2/10]

virtual tmp<vectorField> sample ( const volVectorField ) const
pure virtual

◆ sample() [3/10]

virtual tmp<sphericalTensorField> sample ( const volSphericalTensorField ) const
pure virtual

◆ sample() [4/10]

Foam::tmp< Foam::tensorField > sample ( const volSymmTensorField sField) const
pure virtual

Sample field on surface.

Implemented in patch, triSurfaceMesh, patch, patch, distanceSurface, cuttingPlane, isoSurface, thresholdCellFaces, plane, and patchInternalField.

Definition at line 271 of file sampledSurface.C.

References NotImplemented, and sampledSurface::sample().

Here is the call graph for this function:

◆ sample() [5/10]

virtual tmp<tensorField> sample ( const volTensorField ) const
pure virtual

◆ sample() [6/10]

Foam::tmp< Foam::scalarField > sample ( const surfaceScalarField sField) const
virtual

Surface sample field on surface.

Reimplemented in patch.

Definition at line 241 of file sampledSurface.C.

References NotImplemented, and sampledSurface::sample().

Here is the call graph for this function:

◆ sample() [7/10]

Foam::tmp< Foam::vectorField > sample ( const surfaceVectorField sField) const
virtual

Surface Sample field on surface.

Reimplemented in patch.

Definition at line 251 of file sampledSurface.C.

References NotImplemented, and sampledSurface::sample().

Here is the call graph for this function:

◆ sample() [8/10]

Foam::tmp< Foam::sphericalTensorField > sample ( const surfaceSphericalTensorField sField) const
virtual

Surface sample field on surface.

Reimplemented in patch.

Definition at line 261 of file sampledSurface.C.

References NotImplemented, and sampledSurface::sample().

Here is the call graph for this function:

◆ sample() [9/10]

virtual tmp<symmTensorField> sample ( const surfaceSymmTensorField ) const
virtual

Surface sample field on surface.

Reimplemented in patch, triSurfaceMesh, patch, patch, distanceSurface, cuttingPlane, isoSurface, thresholdCellFaces, plane, and patchInternalField.

◆ sample() [10/10]

virtual tmp<tensorField> sample ( const surfaceTensorField ) const
virtual

Surface sample field on surface.

Reimplemented in patch, triSurfaceMesh, patch, patch, distanceSurface, cuttingPlane, isoSurface, thresholdCellFaces, plane, and patchInternalField.

◆ interpolate() [2/6]

virtual tmp<scalarField> interpolate ( const interpolation< scalar > &  ) const
pure virtual

Interpolate field on surface.

Implemented in triSurfaceMesh, patch, distanceSurface, cuttingPlane, isoSurface, thresholdCellFaces, plane, and patchInternalField.

◆ interpolate() [3/6]

virtual tmp<vectorField> interpolate ( const interpolation< vector > &  ) const
pure virtual

Interpolate field on surface.

Implemented in triSurfaceMesh, patch, distanceSurface, cuttingPlane, isoSurface, thresholdCellFaces, plane, and patchInternalField.

◆ interpolate() [4/6]

virtual tmp<sphericalTensorField> interpolate ( const interpolation< sphericalTensor > &  ) const
pure virtual

Interpolate field on surface.

Implemented in triSurfaceMesh, patch, distanceSurface, cuttingPlane, isoSurface, thresholdCellFaces, plane, and patchInternalField.

◆ interpolate() [5/6]

virtual tmp<symmTensorField> interpolate ( const interpolation< symmTensor > &  ) const
pure virtual

Interpolate field on surface.

Implemented in triSurfaceMesh, patch, distanceSurface, cuttingPlane, isoSurface, thresholdCellFaces, plane, and patchInternalField.

◆ interpolate() [6/6]

virtual tmp<tensorField> interpolate ( const interpolation< tensor > &  ) const
pure virtual

Interpolate field on surface.

Implemented in triSurfaceMesh, patch, distanceSurface, cuttingPlane, isoSurface, thresholdCellFaces, plane, and patchInternalField.

◆ rename()

virtual void rename ( const word newName)
inlinevirtual

Rename.

Definition at line 434 of file sampledSurface.H.

References sampledSurface::operator<<, and sampledSurface::print().

Here is the call graph for this function:

◆ print()

void print ( Ostream os) const
virtual

Write.

Reimplemented in triSurfaceMesh, patch, distanceSurface, cuttingPlane, isoSurface, thresholdCellFaces, plane, and patchInternalField.

Definition at line 341 of file sampledSurface.C.

References Foam::type().

Referenced by Foam::operator<<(), and sampledSurface::rename().

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

◆ project() [6/6]

Foam::tmp<Foam::Field<ReturnType> > project ( const tmp< Field< Type >> &  field) const

Definition at line 146 of file sampledSurfaceTemplates.C.

References sampledSurface::faces(), and sampledSurface::pointAverage().

Here is the call graph for this function:

◆ pointAverage() [2/2]

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<< ( Ostream ,
const sampledSurface  
)
friend

Ostream operator.

Referenced by sampledSurface::rename().


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