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

sampledCuttingPlane Class Reference

A sampledSurface defined by a plane. More...

#include <sampling/sampledCuttingPlane.H>


Detailed Description

A sampledSurface defined by a plane.

Source files

Definition at line 53 of file sampledCuttingPlane.H.

Inheritance diagram for sampledCuttingPlane:
Collaboration diagram for sampledCuttingPlane:

List of all members.

Public Member Functions

 TypeName ("sampledCuttingPlane")
 Runtime type information.
 sampledCuttingPlane (const word &name, const polyMesh &mesh, const dictionary &dict)
 Construct from dictionary.
virtual  ~sampledCuttingPlane ()
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 isoSurface &  surface () const
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

sampledCuttingPlane ( const word &   name,
const polyMesh &   mesh,
const dictionary &   dict  
)
~sampledCuttingPlane (  ) [virtual]

Definition at line 294 of file sampledCuttingPlane.C.


Member Function Documentation

TypeName ( "sampledCuttingPlane"    )

Runtime type information.

bool needsUpdate (  ) const [virtual]

Does the surface need an update?

Implements sampledSurface.

Definition at line 300 of file sampledCuttingPlane.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 306 of file sampledCuttingPlane.C.

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

bool update (  ) [virtual]

Update the surface as required.

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

Implements sampledSurface.

Definition at line 332 of file sampledCuttingPlane.C.

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

virtual const pointField& points (  ) const [inline, virtual]
virtual const faceList& faces (  ) const [inline, virtual]
const isoSurface& surface (  ) const [inline]
Foam::tmp< Foam::scalarField > sample ( const volScalarField &   vField  ) const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 355 of file sampledCuttingPlane.C.

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

sample field on surface

Implements sampledSurface.

Definition at line 365 of file sampledCuttingPlane.C.

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

sample field on surface

Implements sampledSurface.

Definition at line 375 of file sampledCuttingPlane.C.

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

sample field on surface

Implements sampledSurface.

Definition at line 385 of file sampledCuttingPlane.C.

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

sample field on surface

Implements sampledSurface.

Definition at line 395 of file sampledCuttingPlane.C.

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

interpolate field on surface

Implements sampledSurface.

Definition at line 405 of file sampledCuttingPlane.C.

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

interpolate field on surface

Implements sampledSurface.

Definition at line 415 of file sampledCuttingPlane.C.

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

interpolate field on surface

Implements sampledSurface.

Definition at line 424 of file sampledCuttingPlane.C.

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

interpolate field on surface

Implements sampledSurface.

Definition at line 434 of file sampledCuttingPlane.C.

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

interpolate field on surface

Implements sampledSurface.

Definition at line 444 of file sampledCuttingPlane.C.

void print ( Ostream &   os  ) const [virtual]

Write.

Reimplemented from sampledSurface.

Definition at line 452 of file sampledCuttingPlane.C.

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


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