An abstract class for surfaces with sampling. More...

Inheritance diagram for sampledSurface:

[legend]

Classes
class	iNew
	Class used for the PtrLists read-construction. More...

Public Member Functions
	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< sampledSurface >	clone () const
	Clone. More...

virtual	~sampledSurface ()
	Destructor. More...

const polyMesh &	mesh () const
	Access to the underlying mesh. More...

const word &	name () const
	Name of surface. More...

bool	interpolate () const
	Interpolation requested for surface. More...

virtual bool	needsUpdate () const =0
	Does the surface need an update? More...

virtual wordList	fields () const
	Return the list of fields required. More...

virtual bool	expire ()=0
	Mark the surface as needing an update. More...

virtual bool	update ()=0
	Update the surface as required. More...

virtual const pointField &	points () const =0
	Points of surface. More...

virtual const faceList &	faces () const =0
	Faces of surface. More...

virtual const vectorField &	Sf () const
	Return face area vectors. More...

virtual const scalarField &	magSf () const
	Return face area magnitudes. More...

virtual const vectorField &	Cf () 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...

virtual tmp< scalarField >	sample (const volScalarField &) const =0
	Sample field on surface. More...

virtual tmp< vectorField >	sample (const volVectorField &) const =0
	Sample field on surface. More...

virtual tmp< sphericalTensorField >	sample (const volSphericalTensorField &) const =0
	Sample field on surface. More...

virtual tmp< symmTensorField >	sample (const volSymmTensorField &) const =0
	Sample field on surface. More...

virtual tmp< tensorField >	sample (const volTensorField &) const =0
	Sample field on surface. More...

virtual tmp< scalarField >	sample (const surfaceScalarField &) const
	Surface sample field on surface. More...

virtual tmp< vectorField >	sample (const surfaceVectorField &) const
	Surface Sample field on surface. More...

virtual tmp< sphericalTensorField >	sample (const surfaceSphericalTensorField &) const
	Surface sample field on surface. More...

virtual tmp< symmTensorField >	sample (const surfaceSymmTensorField &) const
	Surface sample field on surface. More...

virtual tmp< tensorField >	sample (const surfaceTensorField &) const
	Surface sample field on surface. More...

virtual tmp< scalarField >	interpolate (const interpolation< scalar > &) const =0
	Interpolate field on surface. More...

virtual tmp< vectorField >	interpolate (const interpolation< vector > &) const =0
	Interpolate field on surface. More...

virtual tmp< sphericalTensorField >	interpolate (const interpolation< sphericalTensor > &) const =0
	Interpolate field on surface. More...

virtual tmp< symmTensorField >	interpolate (const interpolation< symmTensor > &) const =0
	Interpolate field on surface. More...

virtual tmp< tensorField >	interpolate (const interpolation< tensor > &) const =0
	Interpolate field on surface. More...

virtual void	rename (const word &newName)
	Rename. More...

virtual void	print (Ostream &) const
	Write. More...

template<class ReturnType , class Type >
Foam::tmp< Foam::Field< ReturnType > >	project (const tmp< Field< Type >> &field) const

Static Public Member Functions
static autoPtr< sampledSurface >	New (const word &name, const polyMesh &, const dictionary &)
	Return a reference to the selected surface. More...

Protected Member Functions
virtual void	clearGeom () const

Friends
Ostream &	operator<< (Ostream &, const sampledSurface &)
	Ostream operator. More...

Detailed Description

An abstract class for surfaces with sampling.

The constructors for the derived classes should generally start in a 'expired' condition (ie, needsUpdate() == true) and rely on a subsequent call to the update() method to complete the initialisation. Delaying the final construction as late as possible allows the construction of surfaces that may depend on intermediate calculation results (eg, iso-surfaces) and also avoids the unnecessary reconstruction of surfaces between sampling intervals.

It is the responsibility of the caller to ensure that the surface update() is called before the surface is used. The update() method implementation should do nothing when the surface is already up-to-date.

Source files

Definition at line 81 of file sampledSurface.H.

Constructor & Destructor Documentation

◆ sampledSurface() [1/2]

sampledSurface	(	const word &	name,
		const polyMesh &	mesh,
		const bool	interpolate = `false`
	)

Construct from name, mesh.

Definition at line 149 of file sampledSurface.C.

◆ sampledSurface() [2/2]

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

Construct from dictionary.

Definition at line 166 of file sampledSurface.C.

References dict.

◆ ~sampledSurface()

~sampledSurface ( )

virtual

Destructor.

Definition at line 187 of file sampledSurface.C.

Member Function Documentation

◆ clearGeom()

void clearGeom ( ) const

protectedvirtual

Definition at line 105 of file sampledSurface.C.

References Foam::deleteDemandDrivenData().

Referenced by sampledIsoSurfaceSurface::expire(), patch::expire(), triSurfaceMesh::expire(), and sampledIsoSurfaceSurface::update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "sampledSurface" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		sampledSurface	,
		word	,
		(const word &name, const polyMesh &mesh, const dictionary &dict)	,
		(name, mesh, dict)
	)

Declare run-time constructor selection table.

◆ clone()

autoPtr<sampledSurface> clone ( ) const

inline

Clone.

Definition at line 221 of file sampledSurface.H.

References NotImplemented.

◆ New()

Foam::autoPtr< Foam::sampledSurface > New	(	const word &	name,
		const polyMesh &	mesh,
		const dictionary &	dict
	)

static

Return a reference to the selected surface.

Definition at line 116 of file sampledSurface.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, dictionary::lookup(), Foam::name(), and Foam::nl.

Referenced by sampledSurface::iNew::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mesh()

const polyMesh& mesh ( ) const

inline

Access to the underlying mesh.

Definition at line 248 of file sampledSurface.H.

Referenced by patchInternalField::patchInternalField(), and triSurfaceMesh::sampleField().

Here is the caller graph for this function:

◆ name()

const word& name ( ) const

inline

Name of surface.

Definition at line 254 of file sampledSurface.H.

Referenced by sampledSurface::iNew::operator()().

Here is the caller graph for this function:

◆ interpolate() [1/6]

bool interpolate ( ) const

inline

Interpolation requested for surface.

Definition at line 260 of file sampledSurface.H.

◆ needsUpdate()

virtual bool needsUpdate ( ) const

pure virtual

Does the surface need an update?

Implemented in triSurfaceMesh, thresholdCellFaces, patch, isoSurface, distanceSurface, and cutPlane.

◆ fields()

virtual wordList fields ( ) const

inlinevirtual

Return the list of fields required.

Reimplemented in thresholdCellFaces, and isoSurface.

Definition at line 269 of file sampledSurface.H.

References List< word >::null().

Here is the call graph for this function:

◆ expire()

virtual bool expire ( )

pure virtual

Mark the surface as needing an update.

May also free up unneeded data. Return false if surface was already marked as expired.

Implemented in triSurfaceMesh, thresholdCellFaces, patch, and sampledIsoSurfaceSurface.

◆ update()

virtual bool update ( )

pure virtual

Update the surface as required.

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

Implemented in triSurfaceMesh, thresholdCellFaces, patch, and sampledIsoSurfaceSurface.

◆ points()

virtual const pointField& points ( ) const

pure virtual

Points of surface.

Implemented in triSurfaceMesh, thresholdCellFaces, patch, and sampledIsoSurfaceSurface.

◆ faces()

virtual const faceList& faces ( ) const

pure virtual

Faces of surface.

Implemented in triSurfaceMesh, thresholdCellFaces, patch, and sampledIsoSurfaceSurface.

◆ Sf()

const Foam::vectorField & Sf ( ) const

virtual

Return face area vectors.

Definition at line 195 of file sampledSurface.C.

◆ magSf()

const Foam::scalarField & magSf ( ) const

virtual

Return face area magnitudes.

Definition at line 206 of file sampledSurface.C.

◆ Cf()

const Foam::vectorField & Cf ( ) const

virtual

Return face centres as vectorField.

Definition at line 217 of file sampledSurface.C.

◆ area()

Foam::scalar area ( ) const

The total surface area.

Definition at line 228 of file sampledSurface.C.

References Foam::reduce(), and Foam::sum().

Here is the call graph for this function:

◆ integrate() [1/2]

Type integrate ( const Field< Type > & field ) const

Integration of a field across the surface.

Definition at line 52 of file sampledSurfaceTemplates.C.

References Foam::reduce(), Foam::sum(), and Foam::Zero.

Here is the call graph for this function:

◆ integrate() [2/2]

Type integrate ( const tmp< Field< Type >> & field ) const

Integration of a field across the surface.

Definition at line 67 of file sampledSurfaceTemplates.C.

◆ average() [1/2]

Type average ( const Field< Type > & field ) const

Area-averaged value of a field across the surface.

Definition at line 76 of file sampledSurfaceTemplates.C.

References Foam::reduce(), Foam::sum(), and Foam::Zero.

Here is the call graph for this function:

◆ average() [2/2]

Type average ( const tmp< Field< Type >> & field ) const

Area-averaged value of a field across the surface.

Definition at line 100 of file sampledSurfaceTemplates.C.

References Foam::average().

Here is the call graph for this function:

◆ project() [1/6]

Foam::tmp< Foam::Field< Foam::scalar > > project ( const Field< scalar > & field ) const

Project field onto surface.

Definition at line 291 of file sampledSurface.C.

References forAll, and tmp< T >::ref().

Here is the call graph for this function:

◆ project() [2/6]

Foam::tmp< Foam::Field< Foam::scalar > > project ( const Field< vector > & field ) const

Project field onto surface.

Definition at line 306 of file sampledSurface.C.

References tmp< T >::ref().

Here is the call graph for this function:

◆ project() [3/6]

Foam::tmp< Foam::Field< Foam::vector > > project ( const Field< sphericalTensor > & field ) const

Project field onto surface.

Definition at line 315 of file sampledSurface.C.

References tmp< T >::ref().

Here is the call graph for this function:

◆ project() [4/6]

Foam::tmp< Foam::Field< Foam::vector > > project ( const Field< symmTensor > & field ) const

Project field onto surface.

Definition at line 324 of file sampledSurface.C.

References sampledSurface::project(), and tmp< T >::ref().

Referenced by sampledSurface::project().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ project() [5/6]

Foam::tmp< Foam::Field< Foam::vector > > project ( const Field< tensor > & field ) const

Project field onto surface.

Definition at line 333 of file sampledSurface.C.

References tmp< T >::ref().

Here is the call graph for this function:

◆ sample() [1/10]

Foam::tmp< Foam::scalarField > sample ( const volScalarField & sField ) const

pure virtual

Sample field on surface.

Implemented in triSurfaceMesh, thresholdCellFaces, patchInternalField, patch, and patch.

Definition at line 240 of file sampledSurface.C.

References NotImplemented.

◆ sample() [2/10]

Foam::tmp< Foam::vectorField > sample ( const volVectorField & sField ) const

pure virtual

Sample field on surface.

Implemented in triSurfaceMesh, thresholdCellFaces, patchInternalField, patch, and patch.

Definition at line 250 of file sampledSurface.C.

References NotImplemented.

◆ sample() [3/10]

Foam::tmp< Foam::sphericalTensorField > sample ( const volSphericalTensorField & sField ) const

pure virtual

Sample field on surface.

Implemented in triSurfaceMesh, thresholdCellFaces, patchInternalField, patch, and patch.

Definition at line 260 of file sampledSurface.C.

References NotImplemented.

◆ sample() [4/10]

Foam::tmp< Foam::symmTensorField > sample ( const volSymmTensorField & sField ) const

pure virtual

Sample field on surface.

Implemented in triSurfaceMesh, thresholdCellFaces, patchInternalField, patch, and patch.

Definition at line 270 of file sampledSurface.C.

References NotImplemented.

◆ sample() [5/10]

Foam::tmp< Foam::tensorField > sample ( const volTensorField & sField ) const

pure virtual

Sample field on surface.

Implemented in triSurfaceMesh, thresholdCellFaces, patchInternalField, patch, and patch.

Definition at line 280 of file sampledSurface.C.

References NotImplemented.

◆ sample() [6/10]

virtual tmp<scalarField> sample ( const surfaceScalarField & ) const

virtual

Surface sample field on surface.

Reimplemented in triSurfaceMesh, thresholdCellFaces, patchInternalField, patch, and patch.

◆ sample() [7/10]

virtual tmp<vectorField> sample ( const surfaceVectorField & ) const

virtual

Surface Sample field on surface.

Reimplemented in triSurfaceMesh, thresholdCellFaces, patchInternalField, patch, and patch.

◆ sample() [8/10]

virtual tmp<sphericalTensorField> sample ( const surfaceSphericalTensorField & ) const

virtual

Surface sample field on surface.

Reimplemented in triSurfaceMesh, thresholdCellFaces, patchInternalField, patch, and patch.

◆ sample() [9/10]

virtual tmp<symmTensorField> sample ( const surfaceSymmTensorField & ) const

virtual

Surface sample field on surface.

Reimplemented in triSurfaceMesh, thresholdCellFaces, patchInternalField, patch, and patch.

◆ sample() [10/10]

virtual tmp<tensorField> sample ( const surfaceTensorField & ) const

virtual

Surface sample field on surface.

Reimplemented in triSurfaceMesh, thresholdCellFaces, patchInternalField, patch, and patch.

◆ interpolate() [2/6]

virtual tmp<scalarField> interpolate ( const interpolation< scalar > & ) const

pure virtual

Interpolate field on surface.

Implemented in triSurfaceMesh, thresholdCellFaces, patchInternalField, and patch.

◆ interpolate() [3/6]

virtual tmp<vectorField> interpolate ( const interpolation< vector > & ) const

pure virtual

Interpolate field on surface.

Implemented in triSurfaceMesh, thresholdCellFaces, patchInternalField, and patch.

◆ interpolate() [4/6]

virtual tmp<sphericalTensorField> interpolate ( const interpolation< sphericalTensor > & ) const

pure virtual

Interpolate field on surface.

Implemented in triSurfaceMesh, thresholdCellFaces, patchInternalField, and patch.

◆ interpolate() [5/6]

virtual tmp<symmTensorField> interpolate ( const interpolation< symmTensor > & ) const

pure virtual

Interpolate field on surface.

Implemented in triSurfaceMesh, thresholdCellFaces, patchInternalField, and patch.

◆ interpolate() [6/6]

virtual tmp<tensorField> interpolate ( const interpolation< tensor > & ) const

pure virtual

Interpolate field on surface.

Implemented in triSurfaceMesh, thresholdCellFaces, patchInternalField, and patch.

◆ rename()

virtual void rename ( const word & newName )

inlinevirtual

Rename.

Definition at line 427 of file sampledSurface.H.

◆ print()

void print ( Ostream & os ) const

virtual

Write.

Reimplemented in triSurfaceMesh, thresholdCellFaces, patchInternalField, patch, isoSurface, distanceSurface, and cutPlane.

Definition at line 341 of file sampledSurface.C.

References Foam::type().

Here is the call graph for this function:

◆ project() [6/6]

Foam::tmp<Foam::Field<ReturnType> > project ( const tmp< Field< Type >> & field ) const

Definition at line 145 of file sampledSurfaceTemplates.C.

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<<	(	Ostream &	,
		const sampledSurface &
	)

friend

Ostream operator.

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

src/sampling/sampledSurface/sampledSurface/sampledSurface.H
src/sampling/sampledSurface/sampledSurface/sampledSurface.C
src/sampling/sampledSurface/sampledSurface/sampledSurfaceTemplates.C

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ sampledSurface() [1/2]

◆ sampledSurface() [2/2]

◆ ~sampledSurface()

Member Function Documentation

◆ clearGeom()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone()

◆ New()

◆ mesh()

◆ name()

◆ interpolate() [1/6]

◆ needsUpdate()

◆ fields()

◆ expire()

◆ update()

◆ points()

◆ faces()

◆ Sf()

◆ magSf()

◆ Cf()

◆ area()

◆ integrate() [1/2]

◆ integrate() [2/2]

◆ average() [1/2]

◆ average() [2/2]

◆ project() [1/6]

◆ project() [2/6]

◆ project() [3/6]

◆ project() [4/6]

◆ project() [5/6]

◆ sample() [1/10]

◆ sample() [2/10]

◆ sample() [3/10]

◆ sample() [4/10]

◆ sample() [5/10]

◆ sample() [6/10]

◆ sample() [7/10]

◆ sample() [8/10]

◆ sample() [9/10]

◆ sample() [10/10]

◆ interpolate() [2/6]

◆ interpolate() [3/6]

◆ interpolate() [4/6]

◆ interpolate() [5/6]

◆ interpolate() [6/6]

◆ rename()

◆ print()

◆ project() [6/6]

Friends And Related Function Documentation

◆ operator<<