A base class for sampled surfaces constructed from iso-surfaces. More...

Inheritance diagram for sampledIsoSurfaceSurface:

[legend]

Collaboration diagram for sampledIsoSurfaceSurface:

Public Member Functions
	TypeName ("sampledIsoSurfaceSurface")
	Runtime type information. More...

	sampledIsoSurfaceSurface (const word &name, const polyMesh &mesh, const dictionary &dict)
	Construct from dictionary. More...

virtual	~sampledIsoSurfaceSurface ()
	Destructor. More...

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

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

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

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

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

	FOR_ALL_FIELD_TYPES (DEFINE_SAMPLE)

	FOR_ALL_FIELD_TYPES (DEFINE_INTERPOLATE)

template<class Type >
Foam::tmp< Foam::Field< Type > >	sampleField (const VolField< Type > &vField) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	interpolateField (const interpolation< Type > &interpolator) const

Public Member Functions inherited from sampledSurface
	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 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

Protected Member Functions
const word &	zoneName () const
	Access the zoneName. More...

const label &	timeIndex () const
	Access the time index. More...

Protected Member Functions inherited from sampledSurface
virtual void	clearGeom () const

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

Detailed Description

A base class for sampled surfaces constructed from iso-surfaces.

Source files

Definition at line 51 of file sampledIsoSurfaceSurface.H.

Constructor & Destructor Documentation

◆ sampledIsoSurfaceSurface()

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

Construct from dictionary.

Definition at line 40 of file sampledIsoSurfaceSurface.C.

References polyMesh::cellZones(), Foam::endl(), ZoneList< ZoneType, ZonesType, MeshType >::found(), sampledSurface::mesh(), word::null, and WarningInFunction.

Here is the call graph for this function:

◆ ~sampledIsoSurfaceSurface()

~sampledIsoSurfaceSurface ( )

virtual

Destructor.

Definition at line 63 of file sampledIsoSurfaceSurface.C.

Member Function Documentation

◆ zoneName()

const word& zoneName ( ) const

inlineprotected

Access the zoneName.

Definition at line 91 of file sampledIsoSurfaceSurface.H.

◆ timeIndex()

const label& timeIndex ( ) const

inlineprotected

Access the time index.

Definition at line 97 of file sampledIsoSurfaceSurface.H.

◆ TypeName()

TypeName ( "sampledIsoSurfaceSurface" )

Runtime type information.

◆ expire()

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 69 of file sampledIsoSurfaceSurface.C.

References sampledSurface::clearGeom().

Here is the call graph for this function:

◆ update() [1/2]

bool update ( )

virtual

Update the surface as required.

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

Implements sampledSurface.

Definition at line 108 of file sampledIsoSurfaceSurface.C.

References sampledIsoSurfaceSurface::update().

Referenced by sampledIsoSurfaceSurface::sampleField(), and sampledIsoSurfaceSurface::update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update() [2/2]

bool update ( ) const

virtual

Update the surface as required.

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

Definition at line 87 of file sampledIsoSurfaceSurface.C.

References sampledSurface::clearGeom().

Here is the call graph for this function:

◆ points()

virtual const pointField& points ( ) const

inlinevirtual

Points of surface.

Implements sampledSurface.

Definition at line 140 of file sampledIsoSurfaceSurface.H.

◆ faces()

virtual const faceList& faces ( ) const

inlinevirtual

Faces of surface.

Implements sampledSurface.

Definition at line 146 of file sampledIsoSurfaceSurface.H.

◆ FOR_ALL_FIELD_TYPES() [1/2]

FOR_ALL_FIELD_TYPES ( DEFINE_SAMPLE )

◆ FOR_ALL_FIELD_TYPES() [2/2]

FOR_ALL_FIELD_TYPES ( DEFINE_INTERPOLATE )

◆ sampleField()

Foam::tmp<Foam::Field<Type> > sampleField ( const VolField< Type > & vField ) const

Definition at line 33 of file sampledIsoSurfaceSurfaceTemplates.C.

References GeometricField< Type, PatchField, GeoMesh >::primitiveField(), and sampledIsoSurfaceSurface::update().

Here is the call graph for this function:

◆ interpolateField()

Foam::tmp<Foam::Field<Type> > interpolateField ( const interpolation< Type > & interpolator ) const

Definition at line 46 of file sampledIsoSurfaceSurfaceTemplates.C.

References forAll, interpolation< Type >::interpolate(), Foam::isA(), points, and GeometricField< Type, PatchField, GeoMesh >::primitiveField().

Here is the call graph for this function:

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

src/sampling/sampledSurface/sampledIsoSurfaceSurface/sampledIsoSurfaceSurface.H
src/sampling/sampledSurface/sampledIsoSurfaceSurface/sampledIsoSurfaceSurface.C
src/sampling/sampledSurface/sampledIsoSurfaceSurface/sampledIsoSurfaceSurfaceTemplates.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ sampledIsoSurfaceSurface()

◆ ~sampledIsoSurfaceSurface()

Member Function Documentation

◆ zoneName()

◆ timeIndex()

◆ TypeName()

◆ expire()

◆ update() [1/2]

◆ update() [2/2]

◆ points()

◆ faces()

◆ FOR_ALL_FIELD_TYPES() [1/2]

◆ FOR_ALL_FIELD_TYPES() [2/2]

◆ sampleField()

◆ interpolateField()