A sampledSurface defined by a plane using an iso-surface algorithm to cut the mesh. More...

Inheritance diagram for sampledCuttingPlane:

Collaboration diagram for sampledCuttingPlane:

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

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

virtual	~sampledCuttingPlane ()=default
	Destructor. More...

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

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

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

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

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

virtual const labelList &	zoneIds () const
	Per-face zone/region information. More...

virtual const vectorField &	Sf () const
	Face area magnitudes. More...

virtual const scalarField &	magSf () const
	Face area magnitudes. More...

virtual const vectorField &	Cf () const
	Face centres. More...

const meshedSurface &	surface () const
	The underlying surface. More...

meshedSurface &	surface ()
	The underlying surface. More...

const labelList &	meshCells () const
	For each face, the original cell in mesh. More...

labelList &	meshCells ()
	For each face, the original cell in mesh. More...

virtual tmp< scalarField >	sample (const interpolation< scalar > &sampler) const
	Sample volume field onto surface faces. More...

virtual tmp< vectorField >	sample (const interpolation< vector > &sampler) const
	Sample volume field onto surface faces. More...

virtual tmp< sphericalTensorField >	sample (const interpolation< sphericalTensor > &sampler) const
	Sample volume field onto surface faces. More...

virtual tmp< symmTensorField >	sample (const interpolation< symmTensor > &sampler) const
	Sample volume field onto surface faces. More...

virtual tmp< tensorField >	sample (const interpolation< tensor > &sampler) const
	Sample volume field onto surface faces. More...

virtual tmp< scalarField >	interpolate (const interpolation< scalar > &interpolator) const
	Interpolate volume field onto surface points. More...

virtual tmp< vectorField >	interpolate (const interpolation< vector > &interpolator) const
	Interpolate volume field onto surface points. More...

virtual tmp< sphericalTensorField >	interpolate (const interpolation< sphericalTensor > &interpolator) const
	Interpolate volume field onto surface points. More...

virtual tmp< symmTensorField >	interpolate (const interpolation< symmTensor > &interpolator) const
	Interpolate volume field onto surface points. More...

virtual tmp< tensorField >	interpolate (const interpolation< tensor > &interpolator) const
	Interpolate volume field onto surface points. More...

virtual void	print (Ostream &os) const
	Print information. More...

template<class Type >
Foam::tmp< Foam::Field< Type > >	sampleOnFaces (const interpolation< Type > &sampler) const

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

template<class Type >
Foam::tmp< Foam::Field< Type > >	isoSurfaceInterpolate (const GeometricField< Type, fvPatchField, volMesh > &cCoords, const Field< Type > &pCoords) 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 &mesh, const bool interpolate=false)
	Construct from name, mesh. More...

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

autoPtr< sampledSurface >	clone () const
	Clone. More...

virtual	~sampledSurface ()
	Destructor - calls clearGeom() More...

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

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

bool	enabled () const
	Surface is enabled. More...

bool	invariant () const
	Surface is invariant with geometry change (caution) More...

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

scalar	area () const
	The total surface area. More...

virtual bool	hasFaceIds () const
	If element ids/order of the original surface are available. More...

virtual const labelList &	originalIds () const

polySurface *	getRegistrySurface (const objectRegistry &obr, word lookupName="") const
	Get surface from registry if available. More...

polySurface *	storeRegistrySurface (objectRegistry &obr, word lookupName="") const
	Copy surface into registry. More...

bool	removeRegistrySurface (objectRegistry &obr, word lookupName="") const
	Remove surface from registry. More...

template<class Type , class GeoMeshType >
bool	storeRegistryField (const objectRegistry &obr, const word &fieldName, const dimensionSet &dims, const Field< Type > &values, word lookupName="") const
	Copy/store sampled field onto registered surface (if it exists) More...

template<class Type , class GeoMeshType >
bool	storeRegistryField (const objectRegistry &obr, const word &fieldName, const dimensionSet &dims, Field< Type > &&values, word lookupName="") const
	Move/store sampled field onto registered surface (if it exists) More...

surfMesh *	getSurfMesh (word lookupName="") const
	Get surface from registry if available. More...

surfMesh *	storeSurfMesh (word lookupName="") const
	Copy surface into registry. More...

bool	removeSurfMesh (word lookupName="") const
	Remove surface from registry. More...

template<class Type , class GeoMeshType >
bool	storeSurfMeshField (const word &fieldName, const dimensionSet &dims, const Field< Type > &values, word lookupName="") const
	Copy/store sampled Face field onto surfMesh (if it exists) More...

template<class Type , class GeoMeshType >
bool	storeSurfMeshField (const word &fieldName, const dimensionSet &dims, Field< Type > &&values, word lookupName="") const
	Move/store sampled Face field onto surfMesh (if it exists) More...

virtual bool	withSurfaceFields () const
	Can it sample surface-fields? More...

virtual tmp< scalarField >	sample (const surfaceScalarField &sField) const
	Sample surface field onto surface. More...

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

virtual tmp< sphericalTensorField >	sample (const surfaceSphericalTensorField &sField) const
	Sample surface field onto surface. More...

virtual tmp< symmTensorField >	sample (const surfaceSymmTensorField &sField) const
	Sample surface field onto surface. More...

virtual tmp< tensorField >	sample (const surfaceTensorField &sField) const
	Sample surface field onto surface. More...

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

template<class Type >
Foam::tmp< Foam::Field< Type > >	sampleOnFaces (const interpolation< Type > &sampler, const labelUList &elements, const faceList &fcs, const pointField &pts)

template<class Type >
Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > >	pointAverage (const GeometricField< Type, pointPatchField, pointMesh > &pfld)

Public Member Functions inherited from meshedSurf
	meshedSurf ()=default
	Construct null. More...

virtual	~meshedSurf ()=default
	Destructor. More...

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

Static Public Attributes inherited from sampledSurface
static const wordList	surfaceFieldTypes
	Class names for surface field types. More...

Protected Member Functions inherited from sampledSurface
virtual void	clearGeom () const
	Additional cleanup when clearing the geometry. More...

	sampledSurface (const word &name, std::nullptr_t)
	Construct null. More...

Static Protected Member Functions inherited from sampledSurface
template<class Type >
static tmp< Field< Type > >	sampleOnFaces (const interpolation< Type > &sampler, const labelUList &elements, const faceList &fcs, const pointField &pts)
	General loop for sampling elements to faces. More...

template<class Type >
static tmp< GeometricField< Type, fvPatchField, volMesh > >	pointAverage (const GeometricField< Type, pointPatchField, pointMesh > &pfld)
	Create cell values by averaging the point values. More...

Detailed Description

A sampledSurface defined by a plane using an iso-surface algorithm to cut the mesh.

This is often embedded as part of a sampled surfaces function object.

Usage

Example of function object partial specification:

surfaces
(
    surface1
    {
        type        cuttingPlane;
        planeType   pointAndNormal;
        pointAndNormalDict
        {
            ...
        }
    }
);

Where the sub-entries comprise:

Property	Description	Required	Default
`type`	cuttingPlane	yes
`planeType`	plane description (pointAndNormal etc)	yes
`mergeTol`	tolerance for merging points	no	1e-6
`isoAlgorithm`	(cell/topo/point)	no	point
`regularise`	point snapping (bool or enum)	no	true
`bounds`	limit with bounding box	no
`zone`	limit to cell zone (name or regex)	no
`zones`	limit to cell zones (names, regexs)	no
`exposedPatchName`	name for zone subset	partly

Note: The keyword zones has priority over zone.

See also: Foam::plane

Source files

Definition at line 146 of file sampledCuttingPlane.H.

Constructor & Destructor Documentation

◆ sampledCuttingPlane()

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

Construct from dictionary.

Definition at line 358 of file sampledCuttingPlane.C.

References polyMesh::boundaryMesh(), polyMesh::cellZones(), DebugInfo, dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalIOErrorInFunction, ZoneMesh< ZoneType, MeshType >::findIndex(), polyBoundaryMesh::findPatchID(), Foam::flatOutput(), dictionary::found(), mesh, polyBoundaryMesh::names(), dictionary::readEntry(), and dictionary::readIfPresent().

Here is the call graph for this function:

◆ ~sampledCuttingPlane()

virtual ~sampledCuttingPlane ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "sampledCuttingPlane" )

Runtime type information.

◆ needsUpdate()

bool needsUpdate ( ) const

virtual

Does the surface need an update?

Implements sampledSurface.

Definition at line 424 of file sampledCuttingPlane.C.

◆ 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 430 of file sampledCuttingPlane.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), and Foam::Pout.

Here is the call graph for this function:

◆ update()

bool update ( )

virtual

Update the surface as required.

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

Implements sampledSurface.

Definition at line 452 of file sampledCuttingPlane.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), and Foam::Pout.

Here is the call graph for this function:

◆ points()

virtual const pointField& points ( ) const

inlinevirtual

Points of surface.

Implements sampledSurface.

Definition at line 269 of file sampledCuttingPlane.H.

References sampledCuttingPlane::surface().

Here is the call graph for this function:

◆ faces()

virtual const faceList& faces ( ) const

inlinevirtual

Faces of surface.

Implements sampledSurface.

Definition at line 275 of file sampledCuttingPlane.H.

References sampledCuttingPlane::surface(), and MeshedSurface< Face >::surfFaces().

Here is the call graph for this function:

◆ zoneIds()

virtual const labelList& zoneIds ( ) const

inlinevirtual

Per-face zone/region information.

Reimplemented from meshedSurf.

Definition at line 281 of file sampledCuttingPlane.H.

References List< label >::null().

Here is the call graph for this function:

◆ Sf()

virtual const vectorField& Sf ( ) const

inlinevirtual

Face area magnitudes.

Implements sampledSurface.

Definition at line 287 of file sampledCuttingPlane.H.

References MeshedSurface< Face >::Sf(), and sampledCuttingPlane::surface().

Here is the call graph for this function:

◆ magSf()

virtual const scalarField& magSf ( ) const

inlinevirtual

Face area magnitudes.

Implements sampledSurface.

Definition at line 293 of file sampledCuttingPlane.H.

References MeshedSurface< Face >::magSf(), and sampledCuttingPlane::surface().

Here is the call graph for this function:

◆ Cf()

virtual const vectorField& Cf ( ) const

inlinevirtual

Face centres.

Implements sampledSurface.

Definition at line 299 of file sampledCuttingPlane.H.

References MeshedSurface< Face >::Cf(), and sampledCuttingPlane::surface().

Here is the call graph for this function:

◆ surface() [1/2]

const meshedSurface& surface ( ) const

inline

The underlying surface.

Definition at line 306 of file sampledCuttingPlane.H.

Referenced by sampledCuttingPlane::Cf(), sampledCuttingPlane::faces(), sampledCuttingPlane::magSf(), sampledCuttingPlane::points(), and sampledCuttingPlane::Sf().

Here is the caller graph for this function:

◆ surface() [2/2]

meshedSurface& surface ( )

inline

The underlying surface.

Definition at line 320 of file sampledCuttingPlane.H.

◆ meshCells() [1/2]

const labelList& meshCells ( ) const

inline

For each face, the original cell in mesh.

Definition at line 334 of file sampledCuttingPlane.H.

◆ meshCells() [2/2]

labelList& meshCells ( )

inline

For each face, the original cell in mesh.

Definition at line 348 of file sampledCuttingPlane.H.

◆ sample() [1/5]

Foam::tmp< Foam::scalarField > sample ( const interpolation< scalar > & sampler ) const

virtual

Sample volume field onto surface faces.

Implements sampledSurface.

Definition at line 474 of file sampledCuttingPlane.C.

◆ sample() [2/5]

Foam::tmp< Foam::vectorField > sample ( const interpolation< vector > & sampler ) const

virtual

Sample volume field onto surface faces.

Implements sampledSurface.

Definition at line 484 of file sampledCuttingPlane.C.

◆ sample() [3/5]

Foam::tmp< Foam::sphericalTensorField > sample ( const interpolation< sphericalTensor > & sampler ) const

virtual

Sample volume field onto surface faces.

Implements sampledSurface.

Definition at line 494 of file sampledCuttingPlane.C.

◆ sample() [4/5]

Foam::tmp< Foam::symmTensorField > sample ( const interpolation< symmTensor > & sampler ) const

virtual

Sample volume field onto surface faces.

Implements sampledSurface.

Definition at line 504 of file sampledCuttingPlane.C.

◆ sample() [5/5]

Foam::tmp< Foam::tensorField > sample ( const interpolation< tensor > & sampler ) const

virtual

Sample volume field onto surface faces.

Implements sampledSurface.

Definition at line 514 of file sampledCuttingPlane.C.

◆ interpolate() [1/5]

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

virtual

Interpolate volume field onto surface points.

Implements sampledSurface.

Definition at line 524 of file sampledCuttingPlane.C.

◆ interpolate() [2/5]

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

virtual

Interpolate volume field onto surface points.

Implements sampledSurface.

Definition at line 534 of file sampledCuttingPlane.C.

◆ interpolate() [3/5]

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

virtual

Interpolate volume field onto surface points.

Implements sampledSurface.

Definition at line 544 of file sampledCuttingPlane.C.

◆ interpolate() [4/5]

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

virtual

Interpolate volume field onto surface points.

Implements sampledSurface.

Definition at line 554 of file sampledCuttingPlane.C.

◆ interpolate() [5/5]

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

virtual

Interpolate volume field onto surface points.

Implements sampledSurface.

Definition at line 564 of file sampledCuttingPlane.C.

◆ print()

void print ( Ostream & os ) const

virtual

Print information.

Reimplemented from sampledSurface.

Definition at line 572 of file sampledCuttingPlane.C.

References Foam::name(), and points.

Here is the call graph for this function:

◆ sampleOnFaces()

Foam::tmp<Foam::Field<Type> > sampleOnFaces ( const interpolation< Type > & sampler ) const

Definition at line 39 of file sampledCuttingPlaneTemplates.C.

References points.

◆ sampleOnPoints()

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

Definition at line 56 of file sampledCuttingPlaneTemplates.C.

References Foam::fac::interpolate(), Foam::New(), and interpolation< Type >::psi().

Here is the call graph for this function:

◆ isoSurfaceInterpolate()

Foam::tmp<Foam::Field<Type> > isoSurfaceInterpolate	(	const GeometricField< Type, fvPatchField, volMesh > &	cCoords,
		const Field< Type > &	pCoords
	)		const

Definition at line 93 of file sampledCuttingPlaneTemplates.C.

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

src/sampling/sampledSurface/sampledCuttingPlane/sampledCuttingPlane.H
src/sampling/sampledSurface/sampledCuttingPlane/sampledCuttingPlane.C
src/sampling/sampledSurface/sampledCuttingPlane/sampledCuttingPlaneTemplates.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ sampledCuttingPlane()

◆ ~sampledCuttingPlane()

Member Function Documentation

◆ TypeName()

◆ needsUpdate()

◆ expire()

◆ update()

◆ points()

◆ faces()

◆ zoneIds()

◆ Sf()

◆ magSf()

◆ Cf()

◆ surface() [1/2]

◆ surface() [2/2]

◆ meshCells() [1/2]

◆ meshCells() [2/2]

◆ sample() [1/5]

◆ sample() [2/5]

◆ sample() [3/5]

◆ sample() [4/5]

◆ sample() [5/5]

◆ interpolate() [1/5]

◆ interpolate() [2/5]

◆ interpolate() [3/5]

◆ interpolate() [4/5]

◆ interpolate() [5/5]

◆ print()

◆ sampleOnFaces()

◆ sampleOnPoints()

◆ isoSurfaceInterpolate()