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

sampledThresholdCellFaces Class Reference

A sampledSurface defined by the cell faces corresponding to a threshold value. More...

#include <sampling/sampledThresholdCellFaces.H>


Detailed Description

A sampledSurface defined by the cell faces corresponding to a threshold value.

Source files

Definition at line 51 of file sampledThresholdCellFaces.H.

Inheritance diagram for sampledThresholdCellFaces:
Collaboration diagram for sampledThresholdCellFaces:

List of all members.

Public Member Functions

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

sampledThresholdCellFaces ( const word &   name,
const polyMesh &   mesh,
const dictionary &   dict  
)

Construct from dictionary.

Definition at line 149 of file sampledThresholdCellFaces.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorIn, and dictionary::found().

~sampledThresholdCellFaces (  ) [virtual]

Definition at line 190 of file sampledThresholdCellFaces.C.


Member Function Documentation

TypeName ( "sampledThresholdCellFaces"    )

Runtime type information.

bool needsUpdate (  ) const [virtual]

Does the surface need an update?

Implements sampledSurface.

Definition at line 196 of file sampledThresholdCellFaces.C.

References mesh, fvMesh::time(), and TimeState::timeIndex().

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 204 of file sampledThresholdCellFaces.C.

bool update (  ) [virtual]

Update the surface as required.

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

Implements sampledSurface.

Definition at line 218 of file sampledThresholdCellFaces.C.

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

Points of surface.

Implements sampledSurface.

Definition at line 142 of file sampledThresholdCellFaces.H.

References PrimitivePatch< face,::Foam::List, pointField, point >::points().

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

Faces of surface.

Implements sampledSurface.

Definition at line 148 of file sampledThresholdCellFaces.H.

References MeshedSurface< face >::faces().

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

sample field on surface

Implements sampledSurface.

Definition at line 226 of file sampledThresholdCellFaces.C.

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

sample field on surface

Implements sampledSurface.

Definition at line 236 of file sampledThresholdCellFaces.C.

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

sample field on surface

Implements sampledSurface.

Definition at line 246 of file sampledThresholdCellFaces.C.

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

sample field on surface

Implements sampledSurface.

Definition at line 256 of file sampledThresholdCellFaces.C.

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

sample field on surface

Implements sampledSurface.

Definition at line 266 of file sampledThresholdCellFaces.C.

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

interpolate field on surface

Implements sampledSurface.

Definition at line 276 of file sampledThresholdCellFaces.C.

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

interpolate field on surface

Implements sampledSurface.

Definition at line 286 of file sampledThresholdCellFaces.C.

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

interpolate field on surface

Implements sampledSurface.

Definition at line 295 of file sampledThresholdCellFaces.C.

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

interpolate field on surface

Implements sampledSurface.

Definition at line 305 of file sampledThresholdCellFaces.C.

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

interpolate field on surface

Implements sampledSurface.

Definition at line 315 of file sampledThresholdCellFaces.C.

void print ( Ostream &   os  ) const [virtual]

Write.

Reimplemented from sampledSurface.

Definition at line 323 of file sampledThresholdCellFaces.C.

References Foam::name().


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