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

A sampledSurface defined by a plane using the iso-surface algorithm to 'cut' the mesh. More...

Inheritance diagram for cuttingPlane:
Collaboration diagram for cuttingPlane:

Public Member Functions

 TypeName ("cuttingPlane")
 Runtime type information. More...
 
 cuttingPlane (const word &name, const polyMesh &mesh, const dictionary &dict)
 Construct from dictionary. More...
 
virtual ~cuttingPlane ()
 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 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 plane using the iso-surface algorithm to 'cut' the mesh.

Example:

{
    type        cuttingPlane;
    planeType   pointAndNormal;
    point       (0 0 0);
    normal      (0 0 1);
    filter      full;
    interpolate yes;
}
Usage
Property Description Required Default value
planeType the method of specification of the plane yes
filter the level of filtering to perform on the iso-surface no full
interpolate interpolate values to the surface points no no
See also
Foam::plane Foam::isoSurface
Source files

Definition at line 97 of file sampledCuttingPlane.H.

Constructor & Destructor Documentation

◆ cuttingPlane()

◆ ~cuttingPlane()

~cuttingPlane ( )
virtual

Destructor.

Definition at line 296 of file sampledCuttingPlane.C.

Member Function Documentation

◆ TypeName()

TypeName ( "cuttingPlane"  )

Runtime type information.

◆ needsUpdate()

bool needsUpdate ( ) const
virtual

Does the surface need an update?

Implements sampledSurface.

Reimplemented in plane.

Definition at line 302 of file sampledCuttingPlane.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.

Reimplemented in plane.

Definition at line 308 of file sampledCuttingPlane.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.

Reimplemented in plane.

Definition at line 330 of file sampledCuttingPlane.C.

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

Here is the call graph for this function:

◆ points()

virtual const pointField& points ( ) const
inlinevirtual

Points of surface.

Implements sampledSurface.

Reimplemented in plane.

Definition at line 191 of file sampledCuttingPlane.H.

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

Referenced by plane::points().

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

◆ faces()

virtual const faceList& faces ( ) const
inlinevirtual

Faces of surface.

Implements sampledSurface.

Reimplemented in plane.

Definition at line 197 of file sampledCuttingPlane.H.

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

Referenced by plane::faces().

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

◆ surface()

const isoSurface& surface ( ) const
inline

Definition at line 202 of file sampledCuttingPlane.H.

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

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

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

◆ sample() [1/5]

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

Sample field on surface.

Implements sampledSurface.

Reimplemented in plane, and plane.

Definition at line 352 of file sampledCuttingPlane.C.

Referenced by cuttingPlane::sample(), cuttingPlane::surface(), and cuttingPlane::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.

Reimplemented in plane.

Definition at line 362 of file sampledCuttingPlane.C.

References cuttingPlane::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.

Reimplemented in plane.

Definition at line 372 of file sampledCuttingPlane.C.

References cuttingPlane::sample().

Here is the call graph for this function:

◆ sample() [4/5]

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

Sample field on surface.

Implements sampledSurface.

Reimplemented in plane, and plane.

◆ sample() [5/5]

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

Sample field on surface.

Implements sampledSurface.

Reimplemented in plane.

Definition at line 392 of file sampledCuttingPlane.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.

Reimplemented in plane.

Definition at line 402 of file sampledCuttingPlane.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.

Reimplemented in plane.

Definition at line 412 of file sampledCuttingPlane.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.

Reimplemented in plane.

Definition at line 421 of file sampledCuttingPlane.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.

Reimplemented in plane.

Definition at line 431 of file sampledCuttingPlane.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.

Reimplemented in plane.

Definition at line 441 of file sampledCuttingPlane.C.

◆ print()

void print ( Ostream os) const
virtual

Write.

Reimplemented from sampledSurface.

Reimplemented in plane.

Definition at line 449 of file sampledCuttingPlane.C.

References Foam::name(), and points.

Referenced by cuttingPlane::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 sampledCuttingPlaneTemplates.C.

◆ interpolateField()

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

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