FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

sampledPlane Class Reference

A sampledSurface defined by a cuttingPlane. Always triangulated. More...

#include <sampling/sampledPlane.H>


Detailed Description

A sampledSurface defined by a cuttingPlane. Always triangulated.

Note: does not cut at construction (since might need fields which are not registered yet). Explicitly call update().

Source files

Definition at line 53 of file sampledPlane.H.

Inheritance diagram for sampledPlane:
Collaboration diagram for sampledPlane:

List of all members.

Public Member Functions

 TypeName ("sampledPlane")
 Runtime type information.
 sampledPlane (const word &name, const polyMesh &mesh, const plane &planeDesc, const word &zoneName=word::null)
 Construct from components.
 sampledPlane (const word &name, const polyMesh &mesh, const dictionary &dict)
 Construct from dictionary.
virtual  ~sampledPlane ()
virtual bool  needsUpdate () const
 Does the surface need an update?
virtual bool  expire ()
 Mark the surface as needing an update.
virtual bool  update ()
 Update the surface as required.
virtual const pointField &  points () const
 Points of surface.
virtual const faceList &  faces () const
 Faces of surface.
const labelList &  meshCells () const
 For every face original cell in mesh.
virtual tmp< scalarField >  sample (const volScalarField &) const
 sample field on surface
virtual tmp< vectorField >  sample (const volVectorField &) const
 sample field on surface
virtual tmp< sphericalTensorField >  sample (const volSphericalTensorField &) const
 sample field on surface
virtual tmp< symmTensorField >  sample (const volSymmTensorField &) const
 sample field on surface
virtual tmp< tensorField >  sample (const volTensorField &) const
 sample field on surface
virtual tmp< scalarField >  interpolate (const interpolation< scalar > &) const
 interpolate field on surface
virtual tmp< vectorField >  interpolate (const interpolation< vector > &) const
 interpolate field on surface
virtual tmp< sphericalTensorField >  interpolate (const interpolation< sphericalTensor > &) const
 interpolate field on surface
virtual tmp< symmTensorField >  interpolate (const interpolation< symmTensor > &) const
 interpolate field on surface
virtual tmp< tensorField >  interpolate (const interpolation< tensor > &) const
 interpolate field on surface
virtual void  print (Ostream &) const
 Write.

Constructor & Destructor Documentation

sampledPlane ( const word &   name,
const polyMesh &   mesh,
const plane &   planeDesc,
const word &   zoneName = word::null  
)

Construct from components.

Definition at line 44 of file sampledPlane.C.

References polyMesh::cellZones(), Foam::endl(), ZoneMesh< ZoneType, MeshType >::findZoneID(), and Foam::Info.

~sampledPlane (  ) [virtual]

Definition at line 108 of file sampledPlane.C.


Member Function Documentation

TypeName ( "sampledPlane"    )

Runtime type information.

bool needsUpdate (  ) const [virtual]

Does the surface need an update?

Implements sampledSurface.

Definition at line 114 of file sampledPlane.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 120 of file sampledPlane.C.

References sampledSurface::clearGeom().

bool update (  ) [virtual]

Update the surface as required.

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

Implements sampledSurface.

Definition at line 135 of file sampledPlane.C.

References polyMesh::cellZones(), sampledSurface::clearGeom(), Foam::endl(), ZoneMesh< ZoneType, MeshType >::findZoneID(), mesh, and Foam::Pout.

virtual const pointField& points (  ) const [inline, virtual]

Points of surface.

Implements sampledSurface.

Definition at line 128 of file sampledPlane.H.

virtual const faceList& faces (  ) const [inline, virtual]

Faces of surface.

Implements sampledSurface.

Definition at line 134 of file sampledPlane.H.

const labelList& meshCells (  ) const [inline]

For every face original cell in mesh.

Definition at line 140 of file sampledPlane.H.

References cuttingPlane::cutCells().

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

sample field on surface

Implements sampledSurface.

Definition at line 172 of file sampledPlane.C.

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

sample field on surface

Implements sampledSurface.

Definition at line 182 of file sampledPlane.C.

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

sample field on surface

Implements sampledSurface.

Definition at line 192 of file sampledPlane.C.

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

sample field on surface

Implements sampledSurface.

Definition at line 202 of file sampledPlane.C.

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

sample field on surface

Implements sampledSurface.

Definition at line 212 of file sampledPlane.C.

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

interpolate field on surface

Implements sampledSurface.

Definition at line 222 of file sampledPlane.C.

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

interpolate field on surface

Implements sampledSurface.

Definition at line 232 of file sampledPlane.C.

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

interpolate field on surface

Implements sampledSurface.

Definition at line 241 of file sampledPlane.C.

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

interpolate field on surface

Implements sampledSurface.

Definition at line 251 of file sampledPlane.C.

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

interpolate field on surface

Implements sampledSurface.

Definition at line 261 of file sampledPlane.C.

void print ( Ostream &   os  ) const [virtual]

Write.

Reimplemented from sampledSurface.

Definition at line 269 of file sampledPlane.C.

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


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