A sampledSurface defined by a plane. More...

Inheritance diagram for cutPlane:

Collaboration diagram for cutPlane:

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

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

virtual	~cutPlane ()
	Destructor. More...

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

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

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

template<class ReturnType , class Type >
Foam::tmp< Foam::Field< ReturnType > >	project (const tmp< Field< Type >> &field) 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...

Protected Member Functions inherited from sampledIsoSurfaceSurface
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

Detailed Description

A sampledSurface defined by a plane.

Example:

{
    type        cutPlane;
    planeType   pointAndNormal;
    point       (0 0 0);
    normal      (0 0 1);
    interpolate yes;
}

Usage

Property	Description	Required	Default value
`planeType`	the method of specification of the plane	yes
`interpolate`	interpolate values to the surface points	no	no

See also: Foam::plane

Source files

Definition at line 86 of file sampledCutPlane.H.

Constructor & Destructor Documentation

◆ cutPlane()

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

Construct from dictionary.

Definition at line 76 of file sampledCutPlane.C.

◆ ~cutPlane()

~cutPlane ( )

virtual

Destructor.

Definition at line 90 of file sampledCutPlane.C.

Member Function Documentation

◆ TypeName()

TypeName ( "cutPlane" )

Runtime type information.

◆ needsUpdate()

bool needsUpdate ( ) const

virtual

Does the surface need an update?

Implements sampledSurface.

Definition at line 96 of file sampledCutPlane.C.

References timeIndex.

◆ print()

void print ( Ostream & os ) const

virtual

Write.

Reimplemented from sampledSurface.

Definition at line 102 of file sampledCutPlane.C.

References Foam::name(), and points.

Here is the call graph for this function:

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

src/sampling/sampledSurface/sampledCutPlane/sampledCutPlane.H
src/sampling/sampledSurface/sampledCutPlane/sampledCutPlane.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cutPlane()

◆ ~cutPlane()

Member Function Documentation

◆ TypeName()

◆ needsUpdate()

◆ print()