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	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)

virtual void	movePoints ()
	Update for mesh point-motion. More...

virtual void	topoChange (const polyTopoChangeMap &)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

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...

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...

template<class Type >
Type	average (const tmp< Field< Type >> &) const
	Area-averaged value of a field across the surface. More...

	FOR_ALL_FIELD_TYPES (DEFINE_SAMPLE)

	FOR_ALL_FIELD_TYPES (DEFINE_INTERPOLATE)

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
autoPtr< cutPolyIsoSurface >	calcIsoSurf (const scalarField &pointValues, const scalar isoValue) const
	Generate the iso-surface for given point and iso-values. 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 52 of file sampledIsoSurfaceSurface.H.

Constructor & Destructor Documentation

◆ sampledIsoSurfaceSurface()

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

Construct from dictionary.

Definition at line 66 of file sampledIsoSurfaceSurface.C.

◆ ~sampledIsoSurfaceSurface()

~sampledIsoSurfaceSurface ( )

virtual

Destructor.

Definition at line 82 of file sampledIsoSurfaceSurface.C.

Member Function Documentation

◆ calcIsoSurf()

Foam::autoPtr< Foam::cutPolyIsoSurface > calcIsoSurf	(	const scalarField &	pointValues,
		const scalar	isoValue
	)		const

protected

Generate the iso-surface for given point and iso-values.

Definition at line 41 of file sampledIsoSurfaceSurface.C.

References generatedCellZone::all(), sampledSurface::mesh(), and generatedCellZone::zone().

Here is the call graph for this function:

◆ timeIndex()

const label& timeIndex ( ) const

inlineprotected

Access the time index.

Definition at line 99 of file sampledIsoSurfaceSurface.H.

◆ TypeName()

TypeName ( "sampledIsoSurfaceSurface" )

Runtime type information.

◆ 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 109 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 88 of file sampledIsoSurfaceSurface.C.

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

Here is the call graph for this function:

◆ points()

virtual const pointField& points ( ) const

inlinevirtual

Points of surface.

Implements sampledSurface.

Definition at line 137 of file sampledIsoSurfaceSurface.H.

◆ faces()

virtual const faceList& faces ( ) const

inlinevirtual

Faces of surface.

Implements sampledSurface.

Definition at line 143 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 )

◆ movePoints()

void movePoints ( )

virtual

Update for mesh point-motion.

Implements sampledSurface.

Definition at line 141 of file sampledIsoSurfaceSurface.C.

References sampledSurface::clearGeom().

Here is the call graph for this function:

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Implements sampledSurface.

Definition at line 150 of file sampledIsoSurfaceSurface.C.

References sampledSurface::clearGeom().

Here is the call graph for this function:

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Implements sampledSurface.

Definition at line 162 of file sampledIsoSurfaceSurface.C.

References sampledSurface::clearGeom().

Here is the call graph for this function:

◆ distribute()

void distribute ( const polyDistributionMap & map )

virtual

Redistribute or update using the given distribution map.

Implements sampledSurface.

Definition at line 174 of file sampledIsoSurfaceSurface.C.

References sampledSurface::clearGeom().

Here is the call graph for this function:

◆ sampleField()

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

Definition at line 34 of file sampledIsoSurfaceSurfaceTemplates.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::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 47 of file sampledIsoSurfaceSurfaceTemplates.C.

References forAll, Foam::isA(), points, and GeometricField< Type, GeoMesh, PrimitiveField >::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

◆ calcIsoSurf()

◆ timeIndex()

◆ TypeName()

◆ update() [1/2]

◆ update() [2/2]

◆ points()

◆ faces()

◆ FOR_ALL_FIELD_TYPES() [1/2]

◆ FOR_ALL_FIELD_TYPES() [2/2]

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ sampleField()

◆ interpolateField()