A sampledSurface defined by a surface of iso value using a topo algorithm. It only recalculates the iso-surface if time changes. To be used in sampleSurfaces / functionObjects. More...
#include <sampledIsoSurfaceTopo.H>
Public Member Functions | |
| TypeNameNoDebug ("sampledIsoSurfaceTopo") | |
| Runtime type information. | |
| sampledIsoSurfaceTopo (const word &name, const polyMesh &mesh, const dictionary &dict) | |
| Construct from dictionary. | |
| virtual | ~sampledIsoSurfaceTopo ()=default |
| Destructor. | |
| Public Member Functions inherited from sampledIsoSurface | |
| TypeName ("sampledIsoSurface") | |
| Runtime type information. | |
| sampledIsoSurface (const isoSurfaceParams ¶ms, const word &name, const polyMesh &mesh, const dictionary &dict) | |
| Construct from dictionary. | |
| sampledIsoSurface (const word &name, const polyMesh &mesh, const dictionary &dict) | |
| Construct from dictionary. | |
| virtual | ~sampledIsoSurface () |
| Destructor. | |
| virtual bool | needsUpdate () const |
| Does the surface need an update? | |
| virtual bool | expire () |
| Mark the surface as needing an update. | |
| virtual bool | update () |
| Update the surface as required. | |
| const meshedSurface & | surface () const |
| The currently created surface geometry. | |
| const labelList & | meshCells () const |
| For each face, the original cell in mesh. | |
| virtual const pointField & | points () const |
| Points of surface. | |
| virtual const faceList & | faces () const |
| Faces of surface. | |
| virtual const labelList & | zoneIds () const |
| Per-face zone/region information. | |
| virtual const vectorField & | Sf () const |
| Face area magnitudes. | |
| virtual const scalarField & | magSf () const |
| Face area magnitudes. | |
| virtual const vectorField & | Cf () const |
| Face centres. | |
| virtual tmp< scalarField > | sample (const interpolation< scalar > &sampler) const |
| Sample volume field onto surface faces. | |
| virtual tmp< vectorField > | sample (const interpolation< vector > &sampler) const |
| Sample volume field onto surface faces. | |
| virtual tmp< sphericalTensorField > | sample (const interpolation< sphericalTensor > &sampler) const |
| Sample volume field onto surface faces. | |
| virtual tmp< symmTensorField > | sample (const interpolation< symmTensor > &sampler) const |
| Sample volume field onto surface faces. | |
| virtual tmp< tensorField > | sample (const interpolation< tensor > &sampler) const |
| Sample volume field onto surface faces. | |
| virtual tmp< scalarField > | interpolate (const interpolation< scalar > &interpolator) const |
| Interpolate volume field onto surface points. | |
| virtual tmp< vectorField > | interpolate (const interpolation< vector > &interpolator) const |
| Interpolate volume field onto surface points. | |
| virtual tmp< sphericalTensorField > | interpolate (const interpolation< sphericalTensor > &interpolator) const |
| Interpolate volume field onto surface points. | |
| virtual tmp< symmTensorField > | interpolate (const interpolation< symmTensor > &interpolator) const |
| Interpolate volume field onto surface points. | |
| virtual tmp< tensorField > | interpolate (const interpolation< tensor > &interpolator) const |
| Interpolate volume field onto surface points. | |
| virtual void | print (Ostream &os, int level=0) const |
| Print information. | |
| 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 > > | sampleOnIsoSurfacePoints (const interpolation< Type > &interpolator) const |
| Public Member Functions inherited from sampledSurface | |
| TypeName ("sampledSurface") | |
| Runtime type information. | |
| declareRunTimeSelectionTable (autoPtr, sampledSurface, word,(const word &name, const polyMesh &mesh, const dictionary &dict),(name, mesh, dict)) | |
| Declare run-time constructor selection table. | |
| sampledSurface (const word &name, const polyMesh &mesh, const bool interpolateToPoints=false) | |
| Construct from name, mesh. | |
| sampledSurface (const word &name, const polyMesh &mesh, const dictionary &dict) | |
| Construct from dictionary. | |
| autoPtr< sampledSurface > | clone () const |
| Clone. | |
| virtual | ~sampledSurface () |
| Destructor - calls clearGeom(). | |
| const polyMesh & | mesh () const noexcept |
| Access to the underlying mesh. | |
| const word & | name () const noexcept |
| Name of surface. | |
| bool | enabled () const noexcept |
| Surface is enabled. | |
| bool | invariant () const noexcept |
| Surface is invariant with geometry change (caution). | |
| bool | isPointData () const noexcept |
| Using interpolation to surface points. | |
| virtual bool | isPointData (const bool on) |
| Change point/cell representation, may trigger an expire(). | |
| scalar | area () const |
| The total surface area. | |
| virtual bool | hasFaceIds () const |
| If element ids/order of the original surface are available. | |
| polySurface * | getRegistrySurface (const objectRegistry &obr, word lookupName="") const |
| Get surface from registry if available. | |
| polySurface * | storeRegistrySurface (objectRegistry &obr, word lookupName="") const |
| Copy surface into registry. | |
| bool | removeRegistrySurface (objectRegistry &obr, word lookupName="") const |
| Remove surface from registry. | |
| 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). | |
| 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). | |
| virtual bool | withSurfaceFields () const |
| Can it sample surface-fields? | |
| virtual tmp< scalarField > | sample (const surfaceScalarField &sField) const |
| Sample surface field onto surface. | |
| virtual tmp< vectorField > | sample (const surfaceVectorField &sField) const |
| Sample surface field onto surface. | |
| virtual tmp< sphericalTensorField > | sample (const surfaceSphericalTensorField &sField) const |
| Sample surface field onto surface. | |
| virtual tmp< symmTensorField > | sample (const surfaceSymmTensorField &sField) const |
| Sample surface field onto surface. | |
| virtual tmp< tensorField > | sample (const surfaceTensorField &sField) const |
| Sample surface field onto surface. | |
| virtual void | rename (const word &newName) |
| Rename. | |
| bool | interpolate () const noexcept |
| Same as isPointData(). | |
| template<class Type> | |
| Foam::tmp< Foam::Field< Type > > | sampleOnFaces (const interpolation< Type > &sampler, const labelUList &elements, const faceList &fcs, const pointField &pts, const Type &defaultValue) |
| template<class Type> | |
| Foam::tmp< Foam::Field< Type > > | sampleOnPoints (const interpolation< Type > &interpolator, const labelUList &elements, const faceList &fcs, const pointField &pts) |
| template<class Type> | |
| Foam::tmp< Foam::VolumeField< Type > > | pointAverage (const PointField< Type > &pfld) |
| Public Member Functions inherited from meshedSurf | |
| constexpr | meshedSurf () noexcept=default |
| Default construct. | |
| virtual | ~meshedSurf ()=default |
| Destructor. | |
| virtual const labelList & | faceIds () const |
| Per-face identifier (eg, element Id). | |
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. | |
| Protected Member Functions inherited from sampledIsoSurface | |
| bool | hasIsoSurface () const |
| Is currently backed by an isoSurfacePtr_. | |
| Protected Member Functions inherited from sampledSurface | |
| virtual void | clearGeom () const |
| Additional cleanup when clearing the geometry. | |
| sampledSurface (const word &name, std::nullptr_t) | |
| Construct null. | |
| 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, const Type &defaultValue=Type(Zero)) |
| Loop for sampling volume elements to faces. | |
| template<class Type> | |
| static tmp< Field< Type > > | sampleOnPoints (const interpolation< Type > &interpolator, const labelUList &elements, const faceList &fcs, const pointField &pts) |
| Loop for interpolating volume elements to face points. | |
| template<class Type> | |
| static tmp< VolumeField< Type > > | pointAverage (const PointField< Type > &pfld) |
| Create cell values by averaging the point values. | |
A sampledSurface defined by a surface of iso value using a topo algorithm. It only recalculates the iso-surface if time changes. To be used in sampleSurfaces / functionObjects.
surfaces
{
surface1
{
type isoSurfaceTopo;
isoField T;
isoValue 373;
}
}
Where the sub-entries comprise:
| Property | Description | Required | Default |
|---|---|---|---|
type | isoSurfaceTopo | yes | |
isoField | field name for obtaining iso-surface | yes | |
isoValue | value of iso-surface | yes | |
average | cell values from averaged point values | no | false |
bounds | limit with bounding box | no | |
zone | limit to cell zone (name or regex) | no | |
zones | limit to cell zones (names, regexs) | no | |
regularise | filter faces (bool or enum) | no | true |
triangulate | triangulate faces (requires regularise) | no | false |
Definition at line 128 of file sampledIsoSurfaceTopo.H.
| sampledIsoSurfaceTopo | ( | const word & | name, |
| const polyMesh & | mesh, | ||
| const dictionary & | dict ) |
Construct from dictionary.
Definition at line 40 of file sampledIsoSurfaceTopo.C.
References dict, sampledSurface::mesh(), Foam::name(), and sampledIsoSurface::sampledIsoSurface().
|
virtualdefault |
Destructor.
| TypeNameNoDebug | ( | "sampledIsoSurfaceTopo" | ) |
Runtime type information.
References dict, sampledSurface::mesh(), and Foam::name().
1.16.1