A sampledSurface defined by a plane which 'cuts' the mesh using the cuttingPlane alorithm. The plane is triangulated by default. More...
Public Member Functions | |
TypeName ("plane") | |
Runtime type information. More... | |
plane (const word &name, const polyMesh &mesh, const plane &planeDesc, const keyType &zoneKey=word::null, const bool triangulate=true) | |
Construct from components. More... | |
plane (const word &name, const polyMesh &mesh, const dictionary &dict) | |
Construct from dictionary. More... | |
virtual | ~plane () |
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... | |
const labelList & | meshCells () const |
For every face original cell in mesh. More... | |
virtual tmp< scalarField > | sample (const volScalarField &) const |
Sample field on surface. More... | |
virtual tmp< vectorField > | sample (const volVectorField &) const |
Sample field on surface. More... | |
virtual tmp< sphericalTensorField > | sample (const volSphericalTensorField &) const |
Sample field on surface. More... | |
virtual tmp< symmTensorField > | sample (const volSymmTensorField &) const |
Sample field on surface. More... | |
virtual tmp< tensorField > | sample (const volTensorField &) const |
Sample field on surface. More... | |
virtual tmp< scalarField > | interpolate (const interpolation< scalar > &) const |
Interpolate field on surface. More... | |
virtual tmp< vectorField > | interpolate (const interpolation< vector > &) const |
Interpolate field on surface. More... | |
virtual tmp< sphericalTensorField > | interpolate (const interpolation< sphericalTensor > &) const |
Interpolate field on surface. More... | |
virtual tmp< symmTensorField > | interpolate (const interpolation< symmTensor > &) const |
Interpolate field on surface. More... | |
virtual tmp< tensorField > | interpolate (const interpolation< tensor > &) const |
Interpolate field on surface. More... | |
virtual void | print (Ostream &) const |
Write. More... | |
template<class Type > | |
Foam::tmp< Foam::Field< Type > > | sampleField (const GeometricField< Type, fvPatchField, volMesh > &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 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... | |
template<class Type > | |
tmp< GeometricField< Type, fvPatchField, volMesh > > | pointAverage (const GeometricField< Type, pointPatchField, pointMesh > &pfld) const |
Interpolate from points to cell centre. More... | |
virtual tmp< scalarField > | sample (const surfaceScalarField &) 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 void | rename (const word &newName) |
Rename. More... | |
template<class ReturnType , class Type > | |
Foam::tmp< Foam::Field< ReturnType > > | project (const tmp< Field< Type >> &field) const |
template<class Type > | |
Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > > | pointAverage (const GeometricField< Type, pointPatchField, pointMesh > &pfld) const |
Public Member Functions inherited from cuttingPlane | |
TypeName ("cuttingPlane") | |
Runtime type information. More... | |
cuttingPlane (const word &name, const polyMesh &mesh, const dictionary &dict) | |
Construct from dictionary. More... | |
virtual | ~cuttingPlane () |
Destructor. More... | |
const isoSurface & | surface () const |
template<class Type > | |
Foam::tmp< Foam::Field< Type > > | sampleField (const GeometricField< Type, fvPatchField, volMesh > &vField) const |
template<class Type > | |
Foam::tmp< Foam::Field< Type > > | interpolateField (const interpolation< Type > &interpolator) 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 sampledSurface | |
virtual void | clearGeom () const |
A sampledSurface defined by a plane which 'cuts' the mesh using the cuttingPlane alorithm. The plane is triangulated by default.
Definition at line 55 of file sampledPlane.H.
plane | ( | const word & | name, |
const polyMesh & | mesh, | ||
const plane & | planeDesc, | ||
const keyType & | zoneKey = word::null , |
||
const bool | triangulate = true |
||
) |
Construct from components.
Definition at line 44 of file sampledPlane.C.
References polyMesh::cellZones(), functionObject::debug, Foam::endl(), ZoneMesh< ZoneType, MeshType >::findIndex(), and Foam::Info.
plane | ( | const word & | name, |
const polyMesh & | mesh, | ||
const dictionary & | dict | ||
) |
Construct from dictionary.
Definition at line 67 of file sampledPlane.C.
References polyMesh::cellZones(), functionObject::debug, Foam::endl(), ZoneMesh< ZoneType, MeshType >::findIndex(), dictionary::found(), Foam::Info, dictionary::readIfPresent(), and dictionary::subDict().
|
virtual |
Destructor.
Definition at line 104 of file sampledPlane.C.
TypeName | ( | "plane" | ) |
Runtime type information.
|
virtual |
Does the surface need an update?
Reimplemented from cuttingPlane.
Definition at line 110 of file sampledPlane.C.
|
virtual |
Mark the surface as needing an update.
May also free up unneeded data. Return false if surface was already marked as expired.
Reimplemented from cuttingPlane.
Definition at line 116 of file sampledPlane.C.
References sampledSurface::clearGeom().
|
virtual |
Update the surface as required.
Do nothing (and return false) if no update was needed
Reimplemented from cuttingPlane.
Definition at line 131 of file sampledPlane.C.
References sampledSurface::clearGeom(), functionObject::debug, UList< T >::empty(), Foam::endl(), mesh, Foam::Pout, and plane::sample().
|
inlinevirtual |
Points of surface.
Reimplemented from cuttingPlane.
Definition at line 133 of file sampledPlane.H.
References cuttingPlane::points().
|
inlinevirtual |
Faces of surface.
Reimplemented from cuttingPlane.
Definition at line 139 of file sampledPlane.H.
References cuttingPlane::faces().
|
inline |
For every face original cell in mesh.
Definition at line 145 of file sampledPlane.H.
References cuttingPlane::cutCells(), sampledSurface::interpolate(), plane::print(), and plane::sample().
|
virtual |
Sample field on surface.
Reimplemented from cuttingPlane.
Definition at line 163 of file sampledPlane.C.
Referenced by plane::meshCells(), plane::sample(), and plane::update().
|
virtual |
Sample field on surface.
Reimplemented from cuttingPlane.
Definition at line 172 of file sampledPlane.C.
References plane::sample().
|
virtual |
Sample field on surface.
Reimplemented from cuttingPlane.
Definition at line 181 of file sampledPlane.C.
References plane::sample().
|
virtual |
Sample field on surface.
Reimplemented from cuttingPlane.
Definition at line 190 of file sampledPlane.C.
References plane::sample().
|
virtual |
Sample field on surface.
Reimplemented from cuttingPlane.
Definition at line 199 of file sampledPlane.C.
References sampledSurface::interpolate().
|
virtual |
Interpolate field on surface.
Reimplemented from cuttingPlane.
Definition at line 208 of file sampledPlane.C.
References sampledSurface::interpolate().
|
virtual |
Interpolate field on surface.
Reimplemented from cuttingPlane.
Definition at line 217 of file sampledPlane.C.
References sampledSurface::interpolate().
|
virtual |
Interpolate field on surface.
Reimplemented from cuttingPlane.
Definition at line 225 of file sampledPlane.C.
References sampledSurface::interpolate().
|
virtual |
Interpolate field on surface.
Reimplemented from cuttingPlane.
Definition at line 234 of file sampledPlane.C.
References sampledSurface::interpolate().
|
virtual |
Interpolate field on surface.
Reimplemented from cuttingPlane.
Definition at line 243 of file sampledPlane.C.
|
virtual |
Write.
Reimplemented from cuttingPlane.
Definition at line 251 of file sampledPlane.C.
References functionObject::name(), and points.
Referenced by plane::meshCells().
Foam::tmp<Foam::Field<Type> > sampleField | ( | const GeometricField< Type, fvPatchField, volMesh > & | vField | ) | const |
Definition at line 33 of file sampledPlaneTemplates.C.
Foam::tmp<Foam::Field<Type> > interpolateField | ( | const interpolation< Type > & | interpolator | ) | const |
Definition at line 44 of file sampledPlaneTemplates.C.
References f(), forAll, interpolation< Type >::interpolate(), points, and tmp< T >::ref().