A sampledSurface defined by a plane which cuts the mesh using the cuttingPlane alorithm. The surface is triangulated by default. More...
Public Member Functions | |
TypeName ("sampledPlane") | |
sampledPlane (const word &name, const polyMesh &mesh, const plane &planeDesc, const wordRes &zones=wordRes(), const bool triangulate=true) | |
sampledPlane (const word &name, const polyMesh &mesh, const dictionary &dict) | |
virtual | ~sampledPlane ()=default |
virtual bool | needsUpdate () const |
virtual bool | expire () |
virtual bool | update () |
virtual const pointField & | points () const |
virtual const faceList & | faces () const |
virtual const labelList & | zoneIds () const |
virtual const vectorField & | Sf () const |
virtual const scalarField & | magSf () const |
virtual const vectorField & | Cf () const |
virtual tmp< scalarField > | sample (const interpolation< scalar > &sampler) const |
virtual tmp< vectorField > | sample (const interpolation< vector > &sampler) const |
virtual tmp< sphericalTensorField > | sample (const interpolation< sphericalTensor > &sampler) const |
virtual tmp< symmTensorField > | sample (const interpolation< symmTensor > &sampler) const |
virtual tmp< tensorField > | sample (const interpolation< tensor > &sampler) const |
virtual tmp< scalarField > | interpolate (const interpolation< scalar > &interpolator) const |
virtual tmp< vectorField > | interpolate (const interpolation< vector > &interpolator) const |
virtual tmp< sphericalTensorField > | interpolate (const interpolation< sphericalTensor > &interpolator) const |
virtual tmp< symmTensorField > | interpolate (const interpolation< symmTensor > &interpolator) const |
virtual tmp< tensorField > | interpolate (const interpolation< tensor > &interpolator) const |
virtual void | print (Ostream &os, int level=0) const |
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 |
![]() | |
TypeName ("sampledSurface") | |
declareRunTimeSelectionTable (autoPtr, sampledSurface, word,(const word &name, const polyMesh &mesh, const dictionary &dict),(name, mesh, dict)) | |
sampledSurface (const word &name, const polyMesh &mesh, const bool interpolateToPoints=false) | |
sampledSurface (const word &name, const polyMesh &mesh, const dictionary &dict) | |
autoPtr< sampledSurface > | clone () const |
virtual | ~sampledSurface () |
const polyMesh & | mesh () const noexcept |
const word & | name () const noexcept |
bool | enabled () const noexcept |
bool | invariant () const noexcept |
bool | isPointData () const noexcept |
virtual bool | isPointData (const bool on) |
scalar | area () const |
virtual bool | hasFaceIds () const |
polySurface * | getRegistrySurface (const objectRegistry &obr, word lookupName="") const |
polySurface * | storeRegistrySurface (objectRegistry &obr, word lookupName="") const |
bool | removeRegistrySurface (objectRegistry &obr, word lookupName="") const |
template<class Type , class GeoMeshType > | |
bool | storeRegistryField (const objectRegistry &obr, const word &fieldName, const dimensionSet &dims, const Field< Type > &values, word lookupName="") const |
template<class Type , class GeoMeshType > | |
bool | storeRegistryField (const objectRegistry &obr, const word &fieldName, const dimensionSet &dims, Field< Type > &&values, word lookupName="") const |
surfMesh * | getSurfMesh (word lookupName="") const |
surfMesh * | storeSurfMesh (word lookupName="") const |
bool | removeSurfMesh (word lookupName="") const |
template<class Type , class GeoMeshType > | |
bool | storeSurfMeshField (const word &fieldName, const dimensionSet &dims, const Field< Type > &values, word lookupName="") const |
template<class Type , class GeoMeshType > | |
bool | storeSurfMeshField (const word &fieldName, const dimensionSet &dims, Field< Type > &&values, word lookupName="") const |
virtual bool | withSurfaceFields () const |
virtual tmp< scalarField > | sample (const surfaceScalarField &sField) const |
virtual tmp< vectorField > | sample (const surfaceVectorField &sField) const |
virtual tmp< sphericalTensorField > | sample (const surfaceSphericalTensorField &sField) const |
virtual tmp< symmTensorField > | sample (const surfaceSymmTensorField &sField) const |
virtual tmp< tensorField > | sample (const surfaceTensorField &sField) const |
virtual void | rename (const word &newName) |
bool | interpolate () const noexcept |
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::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > > | pointAverage (const GeometricField< Type, pointPatchField, pointMesh > &pfld) |
![]() | |
constexpr | meshedSurf () noexcept=default |
virtual | ~meshedSurf ()=default |
virtual const labelList & | faceIds () const |
![]() | |
cuttingPlane (const plane &pln, const primitiveMesh &mesh, const bool triangulate, const bitSet &cellIdLabels=bitSet()) | |
cuttingPlane (const plane &pln, const primitiveMesh &mesh, const bool triangulate, bitSet &&cellIdLabels) | |
cuttingPlane (const plane &pln, const primitiveMesh &mesh, const bool triangulate, const labelUList &cellIdLabels) | |
const plane & | planeDesc () const |
plane & | planeDesc () |
void | operator= (const cuttingPlane &rhs) |
![]() | |
plane () | |
plane (const vector &normalVector) | |
plane (const point &originPoint, const vector &normalVector, const bool doNormalise=true) | |
plane (const point &point1, const point &point2, const point &point3) | |
plane (const scalarList &coeffs) | |
plane (const FixedList< scalar, 4 > &coeffs) | |
plane (const dictionary &dict) | |
plane (Istream &is) | |
const vector & | normal () const |
const point & | origin () const |
point & | origin () |
const point & | refPoint () const |
void | flip () |
FixedList< scalar, 4 > | planeCoeffs () const |
point | nearestPoint (const point &p) const |
scalar | distance (const point &p) const |
scalar | signedDistance (const point &p) const |
scalar | normalIntersect (const point &pnt0, const vector &dir) const |
scalar | normalIntersect (const ray &r) const |
template<class Point , class PointRef > | |
scalar | lineIntersect (const line< Point, PointRef > &l) const |
ray | planeIntersect (const plane &plane2) const |
point | planePlaneIntersect (const plane &plane2, const plane &plane3) const |
point | somePointInPlane (const scalar dist=1e-3) const |
side | sideOfPlane (const point &p) const |
int | sign (const point &p, const scalar tol=SMALL) const |
point | mirror (const point &p) const |
void | writeDict (Ostream &os) const |
![]() | |
cuttingSurfaceBase ()=default | |
virtual | ~cuttingSurfaceBase ()=default |
const labelList & | meshCells () const |
labelList & | meshCells () |
bool | cut () const |
void | operator= (const cuttingSurfaceBase &rhs) |
![]() | |
ClassName ("MeshedSurface") | |
MeshedSurface () | |
MeshedSurface (const MeshedSurface &surf) | |
MeshedSurface (const UnsortedMeshedSurface< Face > &surf) | |
MeshedSurface (MeshedSurface &&surf) | |
MeshedSurface (UnsortedMeshedSurface< Face > &&surf) | |
MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const UList< surfZone > &zoneLst) | |
MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const UList< surfZone > &zoneLst) | |
MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >()) | |
MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >()) | |
MeshedSurface (const polyBoundaryMesh &bMesh, const bool globalPoints=false) | |
MeshedSurface (const surfMesh &mesh) | |
MeshedSurface (const fileName &name) | |
MeshedSurface (const fileName &name, const word &fileType) | |
MeshedSurface (Istream &is) | |
MeshedSurface (const Time &runTime) | |
MeshedSurface (const Time &runTime, const word &surfName) | |
MeshedSurface (const IOobject &io, const dictionary &dict, const bool isGlobal=true) | |
declareRunTimeSelectionTable (autoPtr, MeshedSurface, fileExtension,(const fileName &name),(name)) | |
virtual | ~MeshedSurface () |
declareMemberFunctionSelectionTable (void, UnsortedMeshedSurface, write, fileExtension,(const fileName &name, const MeshedSurface< Face > &surf, IOstreamOption streamOpt, const dictionary &options),(name, surf, streamOpt, options)) | |
label | size () const |
const List< Face > & | surfFaces () const |
const labelList & | faceIds () const |
const surfZoneList & | surfZones () const |
const vectorField & | Sf () const |
const scalarField & | magSf () const |
const vectorField & | Cf () const |
virtual void | clear () |
virtual void | addZones (const UList< surfZone > &, const bool cullEmpty=false) |
virtual void | addZones (const labelUList &sizes, const UList< word > &names, const bool cullEmpty=false) |
virtual void | addZones (const labelUList &sizes, const bool cullEmpty=false) |
bool | addZonesToFaces () |
virtual void | removeZones () |
virtual void | movePoints (const pointField &newPoints) |
virtual void | scalePoints (const scalar scaleFactor) |
virtual void | cleanup (const bool verbose) |
virtual void | compactPoints (labelList &pointMap=const_cast< labelList & >(labelList::null())) |
virtual bool | stitchFaces (const scalar tol=SMALL, const bool verbose=false) |
virtual bool | checkFaces (const bool verbose=false) |
virtual label | nTriangles () const |
virtual label | nTriangles (labelList &faceMap) const |
virtual label | triangulate () |
virtual label | triangulate (labelList &faceMap) |
template<class BoolListType > | |
void | subsetMeshMap (const BoolListType &include, labelList &pointMap, labelList &faceMap) const |
MeshedSurface | subsetMesh (const UList< bool > &include, labelList &pointMap, labelList &faceMap) const |
MeshedSurface | subsetMesh (const bitSet &include, labelList &pointMap, labelList &faceMap) const |
MeshedSurface | subsetMesh (const UList< bool > &include) const |
MeshedSurface | subsetMesh (const bitSet &include) const |
MeshedSurface | subsetMesh (const wordRes &includeNames, const wordRes &excludeNames=wordRes()) const |
void | swap (MeshedSurface< Face > &surf) |
void | transfer (pointField &pointLst, List< Face > &faceLst) |
void | transfer (MeshedSurface< Face > &surf) |
void | transfer (UnsortedMeshedSurface< Face > &surf) |
autoPtr< MeshedSurface< Face > > | releaseGeom () |
void | swapFaces (List< Face > &faces) |
void | swapPoints (pointField &points) |
bool | read (const fileName &name, const word &fileType) |
virtual bool | read (const fileName &name) |
void | writeStats (Ostream &os) const |
virtual void | write (const fileName &name, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const |
virtual void | write (const fileName &name, const word &fileType, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const |
void | write (const Time &runTime, const word &surfName=word::null) const |
void | operator= (const MeshedSurface< Face > &surf) |
void | operator= (MeshedSurface< Face > &&surf) |
operator MeshedSurfaceProxy< Face > () const | |
template<class Face > | |
MeshedSurface () | |
template<class Face > | |
MeshedSurface (const MeshedSurface< Face > &surf) | |
template<class Face > | |
MeshedSurface (const UnsortedMeshedSurface< Face > &surf) | |
template<class Face > | |
MeshedSurface (MeshedSurface< Face > &&surf) | |
template<class Face > | |
MeshedSurface (UnsortedMeshedSurface< Face > &&surf) | |
template<class Face > | |
MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const UList< surfZone > &zoneLst) | |
template<class Face > | |
MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const UList< surfZone > &zoneLst) | |
template<class Face > | |
MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const labelUList &zoneSizes, const UList< word > &zoneNames) | |
template<class Face > | |
MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const labelUList &zoneSizes, const UList< word > &zoneNames) | |
template<class Face > | |
MeshedSurface (const surfMesh &mesh) | |
template<class Face > | |
MeshedSurface (const polyBoundaryMesh &bMesh, const bool useGlobalPoints) | |
template<class Face > | |
MeshedSurface (const fileName &name, const word &fileType) | |
template<class Face > | |
MeshedSurface (const fileName &name) | |
template<class Face > | |
MeshedSurface (Istream &is) | |
template<class Face > | |
MeshedSurface (const Time &runTime) | |
template<class Face > | |
MeshedSurface (const Time &runTime, const word &surfName) | |
template<class Face > | |
MeshedSurface (const IOobject &io, const dictionary &dict, const bool isGlobal) | |
bool | addZonesToFaces () |
bool | addZonesToFaces () |
Additional Inherited Members | |
![]() | |
enum | side { FRONT = 1, BACK = -1, NORMAL = 1, FLIP = -1 } |
![]() | |
typedef Face | face_type |
typedef point | point_type |
![]() | |
static autoPtr< sampledSurface > | New (const word &name, const polyMesh &mesh, const dictionary &dict) |
![]() | |
static wordHashSet | readTypes () |
static wordHashSet | writeTypes () |
static bool | canReadType (const word &fileType, bool verbose=false) |
static bool | canWriteType (const word &fileType, bool verbose=false) |
static bool | canRead (const fileName &name, bool verbose=false) |
static autoPtr< MeshedSurface > | New (const fileName &name, const word &fileType, bool mandatory=true) |
static autoPtr< MeshedSurface > | New (const fileName &name) |
static void | write (const fileName &name, const MeshedSurface< Face > &surf, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) |
static void | write (const fileName &name, const word &fileType, const MeshedSurface< Face > &surf, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) |
![]() | |
static const wordList | surfaceFieldTypes |
![]() | |
static int | debug |
![]() | |
typedef meshedSurface | Mesh |
![]() | |
virtual void | clearGeom () const |
sampledSurface (const word &name, std::nullptr_t) | |
![]() | |
cuttingPlane (const plane &pln) | |
virtual void | performCut (const primitiveMesh &mesh, const bool triangulate, bitSet &&cellIdLabels) |
void | checkOverlap (const word callerName, const boundBox &meshBounds, const boundBox &userBounds) const |
bitSet | cellSelection (const polyMesh &mesh, const boundBox &userBounds, const wordRes &zoneNames, const word callerName, const bool warn) const |
virtual void | performCut (const primitiveMesh &mesh, const bool triangulate, const labelUList &cellIdLabels) |
virtual void | performCut (const primitiveMesh &mesh, const bool triangulate, const bitSet &cellSelectionMask=bitSet()) |
virtual void | performCut (const primitiveMesh &mesh, const bool triangulate, bitSet &&cellSelectionMask)=0 |
![]() | |
template<class EdgeOrientIntersect , class EdgeAlphaIntersect > | |
void | walkCellCuts (const primitiveMesh &mesh, const bitSet &cellCuts, const EdgeOrientIntersect &edgeOrientIntersect, const EdgeAlphaIntersect &edgeAlphaIntersect, const bool triangulate, label nFaceCuts=0) |
virtual void | performCut (const primitiveMesh &mesh, const bool triangulate, const labelUList &cellIdLabels) |
virtual void | performCut (const primitiveMesh &mesh, const bool triangulate, const bitSet &cellSelectionMask=bitSet()) |
virtual void | remapFaces (const labelUList &faceMap) |
![]() | |
void | transcribe (MeshedSurface< face > &surf) |
void | checkZones (const bool verbose=true) |
pointField & | storedPoints () |
List< Face > & | storedFaces () |
labelList & | storedFaceIds () |
surfZoneList & | storedZones () |
void | sortFacesAndStore (DynamicList< Face > &unsortedFaces, DynamicList< label > &zoneIds, DynamicList< label > &elemIds, bool sorted) |
void | transcribe (MeshedSurface< face > &surf) |
void | transcribe (MeshedSurface< face > &surf) |
void | transcribe (MeshedSurface< face > &surf) |
![]() | |
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)) |
template<class Type > | |
static tmp< Field< Type > > | sampleOnPoints (const interpolation< Type > &interpolator, const labelUList &elements, const faceList &fcs, const pointField &pts) |
template<class Type > | |
static tmp< GeometricField< Type, fvPatchField, volMesh > > | pointAverage (const GeometricField< Type, pointPatchField, pointMesh > &pfld) |
![]() | |
static void | checkOverlap (const word callerName, const boundBox &meshBounds, const boundBox &userBounds) |
static bitSet | cellSelection (const polyMesh &mesh, const boundBox &userBounds, const wordRes &zoneNames, boundBox &meshBounds) |
static bitSet | cellSelection (const polyMesh &mesh, const boundBox &userBounds, const wordRes &zoneNames, const word callerName, const bool warn) |
![]() | |
labelList | meshCells_ |
A sampledSurface defined by a plane which cuts the mesh using the cuttingPlane alorithm. The surface is triangulated by default.
This is often embedded as part of a sampled surfaces function object.
surfaces { surface1 { type plane; planeType pointAndNormal; pointAndNormalDict { ... } } }
Where the sub-entries comprise:
Property | Description | Required | Default |
---|---|---|---|
type | plane | yes | |
planeType | plane description (pointAndNormal etc) | yes | |
triangulate | triangulate faces | 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 | |
coordinateSystem | define plane within given coordinate system | no |
zones
has priority over zone
.Definition at line 129 of file sampledPlane.H.
sampledPlane | ( | const word & | name, |
const polyMesh & | mesh, | ||
const plane & | planeDesc, | ||
const wordRes & | zones = wordRes() , |
||
const bool | triangulate = true |
||
) |
Definition at line 62 of file sampledPlane.C.
References polyMesh::cellZones(), Foam::expressions::patchExpr::debug, Foam::endl(), ZoneMesh::findIndex(), Foam::flatOutput(), Foam::Info, and mesh.
sampledPlane | ( | const word & | name, |
const polyMesh & | mesh, | ||
const dictionary & | dict | ||
) |
Definition at line 94 of file sampledPlane.C.
References polyMesh::cellZones(), Foam::expressions::patchExpr::debug, DebugInfo, dict, Foam::endl(), ZoneMesh::findIndex(), Foam::flatOutput(), dictionary::found(), coordinateSystem::globalPosition(), coordinateSystem::globalVector(), Foam::Info, mesh, Foam::name(), coordinateSystem::New(), plane::normal(), plane::origin(), dictionary::readEntry(), and dictionary::readIfPresent().
|
virtualdefault |
TypeName | ( | "sampledPlane" | ) |
|
virtual |
Implements sampledSurface.
Definition at line 165 of file sampledPlane.C.
|
virtual |
Implements sampledSurface.
Definition at line 171 of file sampledPlane.C.
References sampledSurface::clearGeom().
|
virtual |
Implements sampledSurface.
Definition at line 186 of file sampledPlane.C.
References sampledSurface::clearGeom(), Foam::expressions::patchExpr::debug, Foam::endl(), mesh, Foam::Pout, and Foam::BitOps::print().
|
inlinevirtual |
|
inlinevirtual |
Implements sampledSurface.
Definition at line 226 of file sampledPlane.H.
References MeshedSurface::surfFaces().
|
inlinevirtual |
Reimplemented from meshedSurf.
Definition at line 233 of file sampledPlane.H.
References List::null().
|
inlinevirtual |
Implements sampledSurface.
Definition at line 239 of file sampledPlane.H.
References MeshedSurface::Sf().
|
inlinevirtual |
Implements sampledSurface.
Definition at line 245 of file sampledPlane.H.
References MeshedSurface::magSf().
|
inlinevirtual |
Implements sampledSurface.
Definition at line 251 of file sampledPlane.H.
References MeshedSurface::Cf().
|
virtual |
Implements sampledSurface.
Definition at line 209 of file sampledPlane.C.
|
virtual |
Implements sampledSurface.
Definition at line 218 of file sampledPlane.C.
|
virtual |
Implements sampledSurface.
Definition at line 227 of file sampledPlane.C.
|
virtual |
Implements sampledSurface.
Definition at line 236 of file sampledPlane.C.
|
virtual |
Implements sampledSurface.
Definition at line 245 of file sampledPlane.C.
|
virtual |
Implements sampledSurface.
Definition at line 254 of file sampledPlane.C.
|
virtual |
Implements sampledSurface.
Definition at line 263 of file sampledPlane.C.
|
virtual |
Implements sampledSurface.
Definition at line 271 of file sampledPlane.C.
|
virtual |
Implements sampledSurface.
Definition at line 280 of file sampledPlane.C.
|
virtual |
Implements sampledSurface.
Definition at line 289 of file sampledPlane.C.
|
virtual |
Reimplemented from sampledSurface.
Definition at line 297 of file sampledPlane.C.
References Foam::name(), plane::normal(), plane::origin(), os(), and points.
Foam::tmp<Foam::Field<Type> > sampleOnFaces | ( | const interpolation< Type > & | sampler | ) | const |
Definition at line 29 of file sampledPlaneTemplates.C.
References points.
Foam::tmp<Foam::Field<Type> > sampleOnPoints | ( | const interpolation< Type > & | interpolator | ) | const |
Definition at line 46 of file sampledPlaneTemplates.C.
References points.
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.