distanceSurface Class Reference

A sampledSurface defined by a distance to a surface. More...

Inheritance diagram for distanceSurface:
Collaboration diagram for distanceSurface:

Public Member Functions

 TypeName ("distanceSurface")
 Runtime type information. More...
 
 distanceSurface (const word &name, const polyMesh &mesh, const dictionary &dict)
 Construct from dictionary. More...
 
virtual ~distanceSurface ()
 Destructor. More...
 
virtual bool needsUpdate () const
 Does the surface need an update? More...
 
virtual bool expire ()
 Mark the surface as needing an update. More...
 
virtual bool update ()
 Update the surface as required. More...
 
virtual const pointFieldpoints () const
 Points of surface. More...
 
virtual const faceListfaces () const
 Faces of surface. More...
 
const isoSurfacesurface () const
 
virtual tmp< scalarFieldsample (const volScalarField &) const
 Sample field on surface. More...
 
virtual tmp< vectorFieldsample (const volVectorField &) const
 Sample field on surface. More...
 
virtual tmp< sphericalTensorFieldsample (const volSphericalTensorField &) const
 Sample field on surface. More...
 
virtual tmp< symmTensorFieldsample (const volSymmTensorField &) const
 Sample field on surface. More...
 
virtual tmp< tensorFieldsample (const volTensorField &) const
 Sample field on surface. More...
 
virtual tmp< scalarFieldinterpolate (const interpolation< scalar > &) const
 Interpolate field on surface. More...
 
virtual tmp< vectorFieldinterpolate (const interpolation< vector > &) const
 Interpolate field on surface. More...
 
virtual tmp< sphericalTensorFieldinterpolate (const interpolation< sphericalTensor > &) const
 Interpolate field on surface. More...
 
virtual tmp< symmTensorFieldinterpolate (const interpolation< symmTensor > &) const
 Interpolate field on surface. More...
 
virtual tmp< tensorFieldinterpolate (const interpolation< tensor > &) const
 Interpolate field on surface. More...
 
virtual void print (Ostream &) const
 Write. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > sampleField (const GeometricField< Type, fvPatchField, volMesh > &vField) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > interpolateField (const interpolation< Type > &interpolator) const
 
- Public Member Functions inherited from sampledSurface
 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 wordList fields () const
 Return the list of fields required. 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 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 void rename (const word &newName)
 Rename. 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
 

Additional Inherited Members

- Static Public Member Functions inherited from sampledSurface
static autoPtr< sampledSurfaceNew (const word &name, const polyMesh &, const dictionary &)
 Return a reference to the selected surface. More...
 
- Protected Member Functions inherited from sampledSurface
virtual void clearGeom () const
 

Detailed Description

A sampledSurface defined by a distance to a surface.

Example:

{
    type        distanceSurface;
    surfaceType searchableBox;
    min         (-1 -1 -1);
    max         (1 1 1);
    distance    0.1;
    signed      yes;
    filtering   full;
    interpolate yes;
}
Usage
Property Description Required Default value
surfaceType the type of surface to sample from yes
distance the distance from which to sample the surface yes
signed sample only on one side of the surface, specified by the sign of the distance yes
filtering the level of filtering to perform on the iso-surface no full
interpolate interpolate values to the surface points no no
See also
Foam::isoSurface
Source files

Definition at line 110 of file distanceSurface.H.

Constructor & Destructor Documentation

◆ distanceSurface()

◆ ~distanceSurface()

~distanceSurface ( )
virtual

Destructor.

Definition at line 388 of file distanceSurface.C.

Member Function Documentation

◆ TypeName()

TypeName ( "distanceSurface"  )

Runtime type information.

◆ needsUpdate()

bool needsUpdate ( ) const
virtual

Does the surface need an update?

Implements sampledSurface.

Definition at line 394 of file distanceSurface.C.

◆ expire()

bool expire ( )
virtual

Mark the surface as needing an update.

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

Implements sampledSurface.

Definition at line 400 of file distanceSurface.C.

References Foam::endl(), and Foam::Pout.

Here is the call graph for this function:

◆ update()

bool update ( )
virtual

Update the surface as required.

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

Implements sampledSurface.

Definition at line 422 of file distanceSurface.C.

References Foam::endl(), Foam::Pout, and distanceSurface::sample().

Here is the call graph for this function:

◆ points()

virtual const pointField& points ( ) const
inlinevirtual

Points of surface.

Implements sampledSurface.

Definition at line 207 of file distanceSurface.H.

References isoSurface::points(), and distanceSurface::surface().

Here is the call graph for this function:

◆ faces()

virtual const faceList& faces ( ) const
inlinevirtual

Faces of surface.

Implements sampledSurface.

Definition at line 213 of file distanceSurface.H.

References isoSurface::faces(), and distanceSurface::surface().

Here is the call graph for this function:

◆ surface()

const isoSurface& surface ( ) const
inline

Definition at line 218 of file distanceSurface.H.

References sampledSurface::interpolate(), distanceSurface::print(), and distanceSurface::sample().

Referenced by distanceSurface::faces(), and distanceSurface::points().

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

◆ sample() [1/5]

Foam::tmp< Foam::scalarField > sample ( const volScalarField vField) const
virtual

Sample field on surface.

Implements sampledSurface.

Definition at line 444 of file distanceSurface.C.

Referenced by distanceSurface::sample(), distanceSurface::surface(), and distanceSurface::update().

Here is the caller graph for this function:

◆ sample() [2/5]

Foam::tmp< Foam::vectorField > sample ( const volVectorField vField) const
virtual

Sample field on surface.

Implements sampledSurface.

Definition at line 454 of file distanceSurface.C.

References distanceSurface::sample().

Here is the call graph for this function:

◆ sample() [3/5]

Foam::tmp< Foam::sphericalTensorField > sample ( const volSphericalTensorField vField) const
virtual

Sample field on surface.

Implements sampledSurface.

Definition at line 464 of file distanceSurface.C.

References distanceSurface::sample().

Here is the call graph for this function:

◆ sample() [4/5]

Foam::tmp< Foam::symmTensorField > sample ( const volSymmTensorField vField) const
virtual

Sample field on surface.

Implements sampledSurface.

Definition at line 474 of file distanceSurface.C.

References distanceSurface::sample().

Here is the call graph for this function:

◆ sample() [5/5]

Foam::tmp< Foam::tensorField > sample ( const volTensorField vField) const
virtual

Sample field on surface.

Implements sampledSurface.

Definition at line 484 of file distanceSurface.C.

References sampledSurface::interpolate().

Here is the call graph for this function:

◆ interpolate() [1/5]

Foam::tmp< Foam::scalarField > interpolate ( const interpolation< scalar > &  interpolator) const
virtual

Interpolate field on surface.

Implements sampledSurface.

Definition at line 494 of file distanceSurface.C.

References sampledSurface::interpolate().

Here is the call graph for this function:

◆ interpolate() [2/5]

Foam::tmp< Foam::vectorField > interpolate ( const interpolation< vector > &  interpolator) const
virtual

Interpolate field on surface.

Implements sampledSurface.

Definition at line 504 of file distanceSurface.C.

References sampledSurface::interpolate().

Here is the call graph for this function:

◆ interpolate() [3/5]

Foam::tmp< Foam::sphericalTensorField > interpolate ( const interpolation< sphericalTensor > &  interpolator) const
virtual

Interpolate field on surface.

Implements sampledSurface.

Definition at line 513 of file distanceSurface.C.

References sampledSurface::interpolate().

Here is the call graph for this function:

◆ interpolate() [4/5]

Foam::tmp< Foam::symmTensorField > interpolate ( const interpolation< symmTensor > &  interpolator) const
virtual

Interpolate field on surface.

Implements sampledSurface.

Definition at line 523 of file distanceSurface.C.

References sampledSurface::interpolate().

Here is the call graph for this function:

◆ interpolate() [5/5]

Foam::tmp< Foam::tensorField > interpolate ( const interpolation< tensor > &  interpolator) const
virtual

Interpolate field on surface.

Implements sampledSurface.

Definition at line 533 of file distanceSurface.C.

◆ print()

void print ( Ostream os) const
virtual

Write.

Reimplemented from sampledSurface.

Definition at line 541 of file distanceSurface.C.

References Foam::name(), and points.

Referenced by distanceSurface::surface().

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

◆ sampleField()

Foam::tmp<Foam::Field<Type> > sampleField ( const GeometricField< Type, fvPatchField, volMesh > &  vField) const

Definition at line 34 of file distanceSurfaceTemplates.C.

◆ interpolateField()

Foam::tmp<Foam::Field<Type> > interpolateField ( const interpolation< Type > &  interpolator) const

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