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

distanceSurface Class Reference

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

#include <sampling/distanceSurface.H>


Detailed Description

A sampledSurface defined by a distance to a surface.

Source files

Definition at line 52 of file distanceSurface.H.

Inheritance diagram for distanceSurface:
Collaboration diagram for distanceSurface:

List of all members.

Public Member Functions

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

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

Construct from dictionary.

Definition at line 262 of file distanceSurface.C.

~distanceSurface (  ) [virtual]

Definition at line 309 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 315 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 321 of file distanceSurface.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 347 of file distanceSurface.C.

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

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

Faces of surface.

Implements sampledSurface.

Definition at line 151 of file distanceSurface.H.

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

const isoSurface& surface (  ) const [inline]

Definition at line 168 of file distanceSurface.H.

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

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

sample field on surface

Implements sampledSurface.

Definition at line 370 of file distanceSurface.C.

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

sample field on surface

Implements sampledSurface.

Definition at line 380 of file distanceSurface.C.

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

sample field on surface

Implements sampledSurface.

Definition at line 390 of file distanceSurface.C.

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

sample field on surface

Implements sampledSurface.

Definition at line 400 of file distanceSurface.C.

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

sample field on surface

Implements sampledSurface.

Definition at line 410 of file distanceSurface.C.

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

interpolate field on surface

Implements sampledSurface.

Definition at line 420 of file distanceSurface.C.

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

interpolate field on surface

Implements sampledSurface.

Definition at line 430 of file distanceSurface.C.

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

interpolate field on surface

Implements sampledSurface.

Definition at line 439 of file distanceSurface.C.

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

interpolate field on surface

Implements sampledSurface.

Definition at line 449 of file distanceSurface.C.

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

interpolate field on surface

Implements sampledSurface.

Definition at line 459 of file distanceSurface.C.

void print ( Ostream &   os  ) const [virtual]

Write.

Reimplemented from sampledSurface.

Definition at line 467 of file distanceSurface.C.

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


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