Public Member Functions | List of all members
distanceSurface Class Reference

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

Inheritance diagram for distanceSurface:
Inheritance graph
[legend]
Collaboration diagram for distanceSurface:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("distanceSurface")
 Runtime type information. More...
 
 distanceSurface (const word &name, const polyMesh &mesh, const dictionary &dict)
 Construct from dictionary. More...
 
 distanceSurface (const word &name, const polyMesh &mesh, const bool interpolate, const word &surfaceType, const word &surfaceName, const scalar distance, const bool signedDistance, const bool cell, const Switch regularise, const Switch average)
 Construct from components. 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 triSurfacesurface () 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 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< symmTensorFieldsample (const surfaceSymmTensorField &) const
 Surface sample field on surface. More...
 
virtual tmp< tensorFieldsample (const surfaceTensorField &) 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.

Uses either isoSurfaceCell or isoSurface.

Source files

Definition at line 53 of file distanceSurface.H.

Constructor & Destructor Documentation

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

Construct from dictionary.

Definition at line 310 of file distanceSurface.C.

distanceSurface ( const word name,
const polyMesh mesh,
const bool  interpolate,
const word surfaceType,
const word surfaceName,
const scalar  distance,
const bool  signedDistance,
const bool  cell,
const Switch  regularise,
const Switch  average 
)

Construct from components.

Definition at line 357 of file distanceSurface.C.

~distanceSurface ( )
virtual

Destructor.

Definition at line 403 of file distanceSurface.C.

Member Function Documentation

TypeName ( "distanceSurface"  )

Runtime type information.

bool needsUpdate ( ) const
virtual

Does the surface need an update?

Implements sampledSurface.

Definition at line 409 of file distanceSurface.C.

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 415 of file distanceSurface.C.

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

Here is the call graph for this function:

bool update ( )
virtual

Update the surface as required.

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

Implements sampledSurface.

Definition at line 441 of file distanceSurface.C.

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

Here is the call graph for this function:

virtual const pointField& points ( ) const
inlinevirtual

Points of surface.

Implements sampledSurface.

Definition at line 169 of file distanceSurface.H.

References PrimitivePatch< Face, FaceList, PointField, PointType >::points(), and distanceSurface::surface().

Here is the call graph for this function:

virtual const faceList& faces ( ) const
inlinevirtual

Faces of surface.

Implements sampledSurface.

Definition at line 175 of file distanceSurface.H.

References autoPtr< T >::empty(), forAll, autoPtr< T >::reset(), s(), List< T >::size(), and distanceSurface::surface().

Here is the call graph for this function:

const triSurface& surface ( ) const
inline

Definition at line 191 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:

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

Sample field on surface.

Implements sampledSurface.

Definition at line 463 of file distanceSurface.C.

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

Here is the caller graph for this function:

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

Sample field on surface.

Implements sampledSurface.

Definition at line 472 of file distanceSurface.C.

References distanceSurface::sample().

Here is the call graph for this function:

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

Sample field on surface.

Implements sampledSurface.

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

Sample field on surface.

Implements sampledSurface.

Definition at line 490 of file distanceSurface.C.

References distanceSurface::sample().

Here is the call graph for this function:

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

Sample field on surface.

Implements sampledSurface.

Definition at line 499 of file distanceSurface.C.

References sampledSurface::interpolate().

Here is the call graph for this function:

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

Interpolate field on surface.

Implements sampledSurface.

Definition at line 508 of file distanceSurface.C.

References sampledSurface::interpolate().

Here is the call graph for this function:

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

Interpolate field on surface.

Implements sampledSurface.

Definition at line 517 of file distanceSurface.C.

References sampledSurface::interpolate().

Here is the call graph for this function:

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

Interpolate field on surface.

Implements sampledSurface.

Definition at line 525 of file distanceSurface.C.

References sampledSurface::interpolate().

Here is the call graph for this function:

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

Interpolate field on surface.

Implements sampledSurface.

Definition at line 534 of file distanceSurface.C.

References sampledSurface::interpolate().

Here is the call graph for this function:

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

Interpolate field on surface.

Implements sampledSurface.

Definition at line 543 of file distanceSurface.C.

void print ( Ostream os) const
virtual

Write.

Reimplemented from sampledSurface.

Definition at line 551 of file distanceSurface.C.

References Foam::name(), points, and List< T >::size().

Referenced by distanceSurface::surface().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Definition at line 36 of file distanceSurfaceTemplates.C.

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

Definition at line 60 of file distanceSurfaceTemplates.C.

References Foam::MULES::interpolate(), mesh, Foam::compressible::New(), and interpolation< Type >::psi().

Here is the call graph for this function:


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