Variation of sampledPatch that samples the internalField (at a given normal distance from the patch) instead of the patchField. Note: More...
Public Member Functions | |
TypeName ("sampledPatchInternalField") | |
Runtime type information. More... | |
sampledPatchInternalField (const word &name, const polyMesh &mesh, const dictionary &dict) | |
Construct from dictionary. More... | |
virtual | ~sampledPatchInternalField ()=default |
Destructor. More... | |
virtual tmp< scalarField > | sample (const interpolation< scalar > &sampler) const |
Sample boundary of volume field onto surface faces. More... | |
virtual tmp< vectorField > | sample (const interpolation< vector > &sampler) const |
Sample boundary of volume field onto surface faces. More... | |
virtual tmp< sphericalTensorField > | sample (const interpolation< sphericalTensor > &sampler) const |
Sample boundary of volume field onto surface faces. More... | |
virtual tmp< symmTensorField > | sample (const interpolation< symmTensor > &sampler) const |
Sample boundary of volume field onto surface faces. More... | |
virtual tmp< tensorField > | sample (const interpolation< tensor > &sampler) const |
Sample boundary of volume field onto surface faces. More... | |
virtual tmp< scalarField > | interpolate (const interpolation< scalar > &interpolator) const |
Interpolate boundary of volume field onto surface points. More... | |
virtual tmp< vectorField > | interpolate (const interpolation< vector > &interpolator) const |
Interpolate boundary of volume field onto surface points. More... | |
virtual tmp< sphericalTensorField > | interpolate (const interpolation< sphericalTensor > &interpolator) const |
Interpolate boundary of volume field onto surface points. More... | |
virtual tmp< symmTensorField > | interpolate (const interpolation< symmTensor > &interpolator) const |
Interpolate boundary of volume field onto surface points. More... | |
virtual tmp< tensorField > | interpolate (const interpolation< tensor > &interpolator) const |
Interpolate boundary of volume field onto surface points. More... | |
virtual void | print (Ostream &os, int level=0) 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 |
Public Member Functions inherited from sampledPatch | |
TypeName ("sampledPatch") | |
Runtime type information. More... | |
sampledPatch (const word &name, const polyMesh &mesh, const UList< wordRe > &patchNames, const bool triangulate=false) | |
Construct from components. More... | |
sampledPatch (const word &name, const polyMesh &mesh, const dictionary &dict) | |
Construct from dictionary. More... | |
virtual | ~sampledPatch ()=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 vectors. More... | |
virtual const scalarField & | magSf () const |
Face area magnitudes. More... | |
virtual const vectorField & | Cf () const |
Face centres. More... | |
virtual bool | withSurfaceFields () const |
Can it sample surface-fields? More... | |
virtual tmp< scalarField > | sample (const surfaceScalarField &) const |
Sample boundary of surface field on surface. More... | |
virtual tmp< vectorField > | sample (const surfaceVectorField &) const |
Sample boundary of surface field on surface. More... | |
virtual tmp< sphericalTensorField > | sample (const surfaceSphericalTensorField &) const |
Sample boundary of surface field on surface. More... | |
virtual tmp< symmTensorField > | sample (const surfaceSymmTensorField &) const |
Sample boundary of surface field on surface. More... | |
virtual tmp< tensorField > | sample (const surfaceTensorField &) const |
Sample boundary of surface field on surface. More... | |
template<class Type > | |
Foam::tmp< Foam::Field< Type > > | sampleOnFaces (const interpolation< Type > &sampler) const |
template<class Type > | |
Foam::tmp< Foam::Field< Type > > | sampleOnFaces (const SurfaceField< Type > &sField) const |
template<class Type > | |
Foam::tmp< Foam::Field< Type > > | sampleOnPoints (const interpolation< Type > &interpolator) const |
Public Member Functions inherited from MeshedSurface< Face > | |
ClassName ("MeshedSurface") | |
Declare type-name (with debug switch) More... | |
MeshedSurface () | |
Default construct, an empty surface. More... | |
MeshedSurface (const MeshedSurface &surf) | |
Copy construct. More... | |
MeshedSurface (const UnsortedMeshedSurface< Face > &surf) | |
Copy construct from an UnsortedMeshedSurface. More... | |
MeshedSurface (MeshedSurface &&surf) | |
Move construct. More... | |
MeshedSurface (UnsortedMeshedSurface< Face > &&surf) | |
Move construct from an UnsortedMeshedSurface. More... | |
MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const UList< surfZone > &zoneLst) | |
Copy construct from components (points, faces, zones). More... | |
MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const UList< surfZone > &zoneLst) | |
Move construct from components (points, faces). More... | |
MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >()) | |
Copy construct from components (points, faces). More... | |
MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >()) | |
Move construct from components (points, faces). More... | |
MeshedSurface (const polyBoundaryMesh &bMesh, const bool globalPoints=false) | |
Construct from a boundary mesh with local points/faces. More... | |
MeshedSurface (const surfMesh &mesh) | |
Construct from a surfMesh. More... | |
MeshedSurface (const fileName &name) | |
Construct from file name (uses extension to determine type) More... | |
MeshedSurface (const fileName &name, const word &fileType) | |
Construct from file name and given file type. More... | |
MeshedSurface (Istream &is) | |
Construct from Istream. More... | |
MeshedSurface (const Time &runTime) | |
Construct from database (as surfMesh) with default name. More... | |
MeshedSurface (const Time &runTime, const word &surfName) | |
Construct from database (as surfMesh) with given surface name. More... | |
MeshedSurface (const IOobject &io, const dictionary &dict, const bool isGlobal=true) | |
Read construct using IO to find the file location. More... | |
declareRunTimeSelectionTable (autoPtr, MeshedSurface, fileExtension,(const fileName &name),(name)) | |
virtual | ~MeshedSurface () |
Destructor. More... | |
declareMemberFunctionSelectionTable (void, UnsortedMeshedSurface, write, fileExtension,(const fileName &name, const MeshedSurface< Face > &surf, IOstreamOption streamOpt, const dictionary &options),(name, surf, streamOpt, options)) | |
label | size () const |
The surface size is the number of faces. More... | |
const List< Face > & | surfFaces () const |
Return const access to the faces. More... | |
const labelList & | faceIds () const |
Return const access to faces ids. More... | |
const surfZoneList & | surfZones () const |
Const access to the surface zones. More... | |
const vectorField & | Sf () const |
Face area vectors (normals) More... | |
const scalarField & | magSf () const |
Face area magnitudes. More... | |
const vectorField & | Cf () const |
Face centres. More... | |
virtual void | clear () |
Clear all storage. More... | |
virtual void | addZones (const UList< surfZone > &, const bool cullEmpty=false) |
Add surface zones. More... | |
virtual void | addZones (const labelUList &sizes, const UList< word > &names, const bool cullEmpty=false) |
Add surface zones. More... | |
virtual void | addZones (const labelUList &sizes, const bool cullEmpty=false) |
Add surface zones. More... | |
bool | addZonesToFaces () |
Propagate zone information on face regions. More... | |
virtual void | removeZones () |
Remove surface zones. More... | |
virtual void | movePoints (const pointField &newPoints) |
Move points. More... | |
virtual void | scalePoints (const scalar scaleFactor) |
Scale points. A non-positive factor is ignored. More... | |
virtual void | cleanup (const bool verbose) |
Remove invalid faces. More... | |
virtual void | compactPoints (labelList &pointMap=const_cast< labelList &>(labelList::null())) |
Remove unused points and renumber faces in local visit order. More... | |
virtual bool | stitchFaces (const scalar tol=SMALL, const bool verbose=false) |
virtual bool | checkFaces (const bool verbose=false) |
virtual label | nTriangles () const |
Count number of triangles. More... | |
virtual label | nTriangles (labelList &faceMap) const |
Count number of triangles, returning a face map of original ids. More... | |
virtual label | triangulate () |
Triangulate in-place, returning the number of triangles added. More... | |
virtual label | triangulate (labelList &faceMap) |
Triangulate in-place, returning the number of triangles added. More... | |
template<class BoolListType > | |
void | subsetMeshMap (const BoolListType &include, labelList &pointMap, labelList &faceMap) const |
Create mappings for a sub-surface. More... | |
MeshedSurface | subsetMesh (const UList< bool > &include, labelList &pointMap, labelList &faceMap) const |
Return a new surface subsetted on the selected faces. More... | |
MeshedSurface | subsetMesh (const bitSet &include, labelList &pointMap, labelList &faceMap) const |
Return a new surface subsetted on the selected faces. More... | |
MeshedSurface | subsetMesh (const UList< bool > &include) const |
Return a new surface subsetted on the selected faces. More... | |
MeshedSurface | subsetMesh (const bitSet &include) const |
Return a new surface subsetted on the selected faces. More... | |
MeshedSurface | subsetMesh (const wordRes &includeNames, const wordRes &excludeNames=wordRes()) const |
Return a new surface subsetted on the selected zone names. More... | |
void | swap (MeshedSurface< Face > &surf) |
Swap contents. More... | |
void | transfer (pointField &pointLst, List< Face > &faceLst) |
Transfer the components. More... | |
void | transfer (MeshedSurface< Face > &surf) |
Transfer the contents of the argument and annul the argument. More... | |
void | transfer (UnsortedMeshedSurface< Face > &surf) |
Transfer the contents of the argument and annul the argument. More... | |
autoPtr< MeshedSurface< Face > > | releaseGeom () |
Release (clear) geometry and return for reuse. More... | |
void | swapFaces (List< Face > &faces) |
Swap the stored faces. Use with caution. More... | |
void | swapPoints (pointField &points) |
Swap the stored points. More... | |
bool | read (const fileName &name, const word &fileType) |
Read from file. Chooses reader based on explicit extension. More... | |
virtual bool | read (const fileName &name) |
Read from file. Chooses reader based on detected extension. More... | |
void | writeStats (Ostream &os) const |
virtual void | write (const fileName &name, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const |
Generic write routine. Chooses writer based on extension. More... | |
virtual void | write (const fileName &name, const word &fileType, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const |
Generic write routine for given format type. More... | |
void | write (const Time &runTime, const word &surfName=word::null) const |
Write to database. More... | |
void | operator= (const MeshedSurface< Face > &surf) |
Copy assignment. More... | |
void | operator= (MeshedSurface< Face > &&surf) |
Move assignment. More... | |
operator MeshedSurfaceProxy< Face > () const | |
Conversion operator to MeshedSurfaceProxy. More... | |
template<class Face> | |
MeshedSurface (const MeshedSurface< Face > &surf) | |
template<class Face> | |
MeshedSurface (MeshedSurface< Face > &&surf) | |
template<> | |
bool | addZonesToFaces () |
Specialization for labelledTri. More... | |
template<> | |
bool | addZonesToFaces () |
Public Member Functions inherited from PrimitivePatch<::Foam::List< Face >, pointField > | |
PrimitivePatch (const ::Foam::List< Face > &faces, const pointField &points) | |
Construct from components. More... | |
PrimitivePatch (::Foam::List< Face > &&faces, const pointField &points) | |
Construct from components, transferring faces. More... | |
PrimitivePatch (::Foam::List< Face > &faces, pointField &points, const bool reuse) | |
Construct from components, reuse storage. More... | |
PrimitivePatch (const PrimitivePatch< ::Foam::List< Face >, pointField > &pp) | |
Copy construct. More... | |
virtual | ~PrimitivePatch () |
Destructor. More... | |
void | clearOut () |
void | clearGeom () |
void | clearTopology () |
void | clearPatchMeshAddr () |
void | swap (PrimitivePatch &)=delete |
Suppress direct swapping, since storage containers may be const. More... | |
const Field< point_type > & | points () const noexcept |
Return reference to global points. More... | |
label | nFaces () const noexcept |
Number of faces in the patch. More... | |
label | nPoints () const |
Number of points supporting patch faces. More... | |
label | nEdges () const |
Number of edges in patch. More... | |
const edgeList & | edges () const |
Return list of edges, address into LOCAL point list. More... | |
const edgeList::subList | internalEdges () const |
Return sub-list of internal edges, address into LOCAL point list. More... | |
const edgeList::subList | boundaryEdges () const |
Return sub-list of boundary edges, address into LOCAL point list. More... | |
label | nInternalEdges () const |
Number of internal edges. More... | |
label | nBoundaryEdges () const |
Number of boundary edges == (nEdges() - nInternalEdges()) More... | |
bool | isInternalEdge (const label edgei) const |
Is internal edge? More... | |
const labelList & | boundaryPoints () const |
Return list of boundary points, address into LOCAL point list. More... | |
const labelListList & | faceFaces () const |
Return face-face addressing. More... | |
const labelListList & | edgeFaces () const |
Return edge-face addressing. More... | |
const labelListList & | faceEdges () const |
Return face-edge addressing. More... | |
const labelListList & | pointEdges () const |
Return point-edge addressing. More... | |
const labelListList & | pointFaces () const |
Return point-face addressing. More... | |
const List< face_type > & | localFaces () const |
Return patch faces addressing into local point list. More... | |
labelList | boundaryFaces () const |
Extract list of local faces corresponding to the boundary edges. More... | |
labelList | uniqBoundaryFaces () const |
Extract sorted list of unique local faces associated with the boundary edges. More... | |
const labelList & | meshPoints () const |
Return labelList of mesh points in patch. More... | |
const Map< label > & | meshPointMap () const |
Mesh point map. More... | |
const Field< point_type > & | localPoints () const |
Return pointField of points in patch. More... | |
const labelList & | localPointOrder () const |
Return orders the local points for most efficient search. More... | |
label | whichPoint (const label gp) const |
Given a global point index, return the local point index. More... | |
edge | meshEdge (const label edgei) const |
From patch edge to global edge using meshPoints. More... | |
edge | meshEdge (const edge &e) const |
From patch edge to global edge using meshPoints. More... | |
label | meshEdge (const label edgei, const edgeList &allEdges, const labelListList &pointEdges) const |
Return label of the local patch edge into the global edge list using basic edge addressing. More... | |
label | findEdge (const edge &e) const |
Search for edge (local point labels) and return its index in the edge list or -1 if not found. More... | |
labelList | meshEdges (const edgeList &allEdges, const labelListList &cellEdges, const labelList &faceCells) const |
Return labels of patch edges in the global edge list using cell addressing. More... | |
labelList | meshEdges (const edgeList &allEdges, const labelListList &pointEdges) const |
Return labels of patch edges into the global edge list using basic edge addressing. More... | |
labelList | meshEdges (const labelUList &edgeLabels, const edgeList &allEdges, const labelListList &pointEdges) const |
Return labels of specified patch edges into the global edge list using basic edge addressing. More... | |
const Field< point_type > & | faceCentres () const |
Return face centres for patch. More... | |
const Field< point_type > & | faceAreas () const |
Return face area vectors for patch. More... | |
const Field< scalar > & | magFaceAreas () const |
Return face area magnitudes for patch. More... | |
const Field< point_type > & | faceNormals () const |
Return face unit normals for patch. More... | |
const Field< point_type > & | pointNormals () const |
Return point normals for patch. More... | |
Pair< point_type > | box () const |
The enclosing (bounding) box for the patch points. More... | |
scalar | sphere (const label facei) const |
The enclosing (bounding) sphere radius^2 for specified face. More... | |
bool | hasFaceAreas () const |
bool | hasFaceCentres () const |
bool | hasFaceNormals () const |
bool | hasPointNormals () const |
bool | hasBoundaryPoints () const |
bool | hasEdges () const |
bool | hasFaceFaces () const |
bool | hasEdgeFaces () const |
bool | hasFaceEdges () const |
bool | hasPointEdges () const |
bool | hasPointFaces () const |
bool | hasMeshPoints () const |
bool | hasMeshPointMap () const |
List< objectHit > | projectPoints (const ToPatch &targetPatch, const Field< point_type > &projectionDirection, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction=intersection::VECTOR) const |
Project vertices of patch onto another patch. More... | |
Foam::List< Foam::objectHit > | projectPoints (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< ::Foam::List< Face >, pointField >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const |
List< objectHit > | projectFaceCentres (const ToPatch &targetPatch, const Field< point_type > &projectionDirection, const intersection::algorithm=intersection::FULL_RAY, const intersection::direction=intersection::VECTOR) const |
Project vertices of patch onto another patch. More... | |
Foam::List< Foam::objectHit > | projectFaceCentres (const ToPatch &targetPatch, const Field< typename Foam::PrimitivePatch< ::Foam::List< Face >, pointField >::point_type > &projectionDirection, const intersection::algorithm alg, const intersection::direction dir) const |
const labelListList & | edgeLoops () const |
Return list of closed loops of boundary vertices. More... | |
surfaceTopo | surfaceType (labelHashSet *badEdgesPtr=nullptr) const |
Calculate surface type formed by patch, optionally recording the indices of illegal edges. More... | |
bool | checkTopology (const bool report=false, labelHashSet *pointSetPtr=nullptr) const |
Check surface formed by patch for manifoldness (see above). More... | |
bool | checkPointManifold (const bool report=false, labelHashSet *pointSetPtr=nullptr) const |
Checks primitivePatch for faces sharing point but not edge. More... | |
virtual void | movePoints (const Field< point_type > &) |
Correct patch after moving points. More... | |
void | operator= (const PrimitivePatch< ::Foam::List< Face >, pointField > &rhs) |
Copy assign faces. Leave points alone (could be a reference). More... | |
void | operator= (PrimitivePatch< ::Foam::List< Face >, pointField > &&rhs) |
Move assign faces. Leave points alone (could be a reference). More... | |
label | whichEdge (const edge &e) const |
Identical to findEdge. More... | |
Public Member Functions inherited from PrimitivePatchBase | |
ClassName ("PrimitivePatch") | |
Runtime type information. More... | |
PrimitivePatchBase ()=default | |
Default construct. More... | |
Public Member Functions inherited from List< Face > | |
constexpr | List () noexcept |
Default construct. More... | |
List (const label len) | |
Construct with given size. More... | |
List (const label len, const Face &val) | |
Construct with given size and value for all elements. More... | |
List (const label len, const Foam::zero) | |
Construct with given size initializing all elements to zero. More... | |
List (const Foam::one, const Face &val) | |
Construct with length=1, copying the value as the only content. More... | |
List (const Foam::one, Face &&val) | |
Construct with length=1, moving the value as the only content. More... | |
List (const Foam::one, const Foam::zero) | |
Construct with length=1, initializing content to zero. More... | |
List (const List< Face > &list) | |
Copy construct from list. More... | |
List (const UList< Face > &list) | |
Copy construct contents from list. More... | |
List (List< Face > &list, bool reuse) | |
Construct as copy or re-use as specified. More... | |
List (const UList< Face > &list, const labelUList &indices) | |
Copy construct subset of list. More... | |
List (const UList< Face > &list, const FixedList< label, N > &indices) | |
Copy construct subset of list. More... | |
List (const FixedList< Face, N > &list) | |
Construct as copy of FixedList<T, N> More... | |
List (const PtrList< Face > &list) | |
Construct as copy of PtrList<T> More... | |
List (const IndirectListBase< Face, Addr > &list) | |
Construct as copy of IndirectList contents. More... | |
List (std::initializer_list< Face > list) | |
Construct from an initializer list. More... | |
List (List< Face > &&list) noexcept | |
Move construct from List. More... | |
List (DynamicList< Face, SizeMin > &&list) | |
Move construct from DynamicList. More... | |
List (Istream &is) | |
Construct from Istream. More... | |
List (const SLList< Face > &list) | |
Copy construct from SLList. More... | |
autoPtr< List< Face > > | clone () const |
Clone. More... | |
~List () | |
Destructor. More... | |
void | clear () |
Clear the list, i.e. set size to zero. More... | |
void | resize (const label len) |
Adjust allocated size of list. More... | |
void | resize (const label len, const Face &val) |
Adjust allocated size of list and set val for new elements. More... | |
void | resize (const label newLen) |
void | resize_fill (const label len, const Face &val) |
Adjust allocated size of list and set val for all elements. More... | |
void | resize_nocopy (const label len) |
Adjust allocated size of list without necessarily. More... | |
void | resize_unsafe (const label len) noexcept |
Change the addressed list size directly without affecting any memory management (advanced usage). More... | |
void | setSize (const label n) |
Alias for resize() More... | |
void | setSize (const label n, const Face &val) |
Alias for resize() More... | |
void | transfer (List< Face > &list) |
Transfer the contents of the argument List into this list and annul the argument list. More... | |
void | transfer (DynamicList< Face, SizeMin > &list) |
Transfer the contents of the argument List into this list and annul the argument list. More... | |
Face & | newElmt (const label i) |
Return subscript-checked element of UList and resizing the list if required. More... | |
Face & | emplace_back (Args &&... args) |
Construct an element at the end of the list, return reference to the new list element. More... | |
void | push_back (const Face &val) |
Append an element at the end of the list. More... | |
void | push_back (Face &&val) |
Move append an element at the end of the list. More... | |
void | push_back (const UList< Face > &list) |
Append a List to the end of this list. More... | |
void | push_back (const IndirectListBase< Face, Addr > &list) |
Append IndirectList contents at the end of this list. More... | |
label | push_uniq (const Face &val) |
Append an element if not already in the list. More... | |
void | pop_back (label n=1) |
Reduce size by 1 or more elements. Can be called on an empty list. More... | |
void | operator= (const UList< Face > &list) |
Assignment to UList operator. Takes linear time. More... | |
void | operator= (const List< Face > &list) |
Assignment operator. Takes linear time. More... | |
void | operator= (const IndirectListBase< Face, Addr > &list) |
Assignment from IndirectList. Takes linear time. More... | |
void | operator= (const FixedList< Face, N > &list) |
Copy assignment from FixedList. More... | |
void | operator= (std::initializer_list< Face > list) |
Assignment to an initializer list. More... | |
void | operator= (const Face &val) |
Assignment of all entries to the given value. More... | |
void | operator= (const Foam::zero) |
Assignment of all entries to zero. More... | |
void | operator= (List< Face > &&list) |
Move assignment. Takes constant time. More... | |
void | operator= (DynamicList< Face, SizeMin > &&list) |
Move assignment. Takes constant time. More... | |
void | operator= (const SLList< Face > &list) |
Copy assign from SLList in linear time. More... | |
Istream & | readList (Istream &is) |
Read List from Istream, discarding contents of existing List. More... | |
void | shallowCopy (const UList< Face > &)=delete |
No shallowCopy permitted. More... | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | set (const label i, bool val=true) |
A bitSet::set() method for a list of bool. More... | |
void | append (const Face &val) |
Append an element at the end of the list. More... | |
void | append (Face &&val) |
Move append an element at the end of the list. More... | |
void | append (const UList< Face > &list) |
Append a List to the end of this list. More... | |
void | append (const IndirectListBase< Face, Addr > &list) |
Append IndirectList contents at the end of this list. More... | |
label | appendUniq (const Face &val) |
Same as push_uniq() More... | |
Public Member Functions inherited from UList< Face > | |
label | size () const noexcept |
The number of elements in the container. More... | |
void | writeEntry (const word &keyword, Ostream &os) const |
Write the List as a dictionary entry with keyword. More... | |
void | operator= (const Face &val) |
Assignment of all entries to the given value. More... | |
void | operator= (const Foam::zero) |
Assignment of all entries to zero. More... | |
UList (const UList< Face > &)=default | |
Copy construct. More... | |
constexpr | UList () noexcept |
Default construct, zero-sized and nullptr. More... | |
UList (Face *__restrict__ v, const label len) noexcept | |
Construct from components. More... | |
label | fcIndex (const label i) const noexcept |
The forward circular index. The next index in the list which returns to the first at the end of the list. More... | |
label | rcIndex (const label i) const noexcept |
The reverse circular index. The previous index in the list which returns to the last at the beginning of the list. More... | |
const Face & | fcValue (const label i) const |
Return forward circular value (ie, next value in the list) More... | |
Face & | fcValue (const label i) |
Return forward circular value (ie, next value in the list) More... | |
const Face & | rcValue (const label i) const |
Return reverse circular value (ie, previous value in the list) More... | |
Face & | rcValue (const label i) |
Return reverse circular value (ie, previous value in the list) More... | |
const Face * | cdata () const noexcept |
Return pointer to the underlying array serving as data storage. More... | |
Face * | data () noexcept |
Return pointer to the underlying array serving as data storage. More... | |
const char * | cdata_bytes () const noexcept |
Return pointer to the underlying array serving as data storage,. More... | |
char * | data_bytes () noexcept |
Return pointer to the underlying array serving as data storage,. More... | |
Face & | front () |
Access first element of the list, position [0]. More... | |
const Face & | front () const |
Access first element of the list. More... | |
Face & | back () |
Access last element of the list, position [size()-1]. More... | |
const Face & | back () const |
Access last element of the list, position [size()-1]. More... | |
std::streamsize | size_bytes () const noexcept |
Number of contiguous bytes for the List data. More... | |
std::streamsize | byteSize () const |
Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. More... | |
void | checkStart (const label start) const |
Check start is within valid range [0,size) More... | |
void | checkSize (const label size) const |
Check size is within valid range [0,size]. More... | |
void | checkRange (const label start, const label len) const |
Check that start and length define a valid range. More... | |
void | checkIndex (const label i) const |
Check index is within valid range [0,size) More... | |
bool | uniform () const |
True if all entries have identical values, and list is non-empty. More... | |
bool | contains (const Face &val) const |
True if the value is contained in the list. More... | |
bool | contains (const Face &val, label pos, label len=-1) const |
Is the value contained in the list? More... | |
label | find (const Face &val) const |
Find index of the first occurrence of the value. More... | |
label | find (const Face &val, label pos, label len=-1) const |
Find index of the first occurrence of the value. More... | |
label | rfind (const Face &val, label pos=-1) const |
Find index of the last occurrence of the value. More... | |
void | moveFirst (const label i) |
Move element to the first position. More... | |
void | moveLast (const label i) |
Move element to the last position. More... | |
void | swapFirst (const label i) |
Swap element with the first element. Fatal on an empty list. More... | |
void | swapLast (const label i) |
Swap element with the last element. Fatal on an empty list. More... | |
void | shallowCopy (Face *__restrict__ ptr, const label len) noexcept |
Copy the pointer and size. More... | |
void | shallowCopy (std::nullptr_t) noexcept |
Copy nullptr and zero size. More... | |
void | shallowCopy (const UList< Face > &list) noexcept |
Copy the pointer and size held by the given UList. More... | |
void | deepCopy (const UList< Face > &list) |
Copy elements of the given UList. Sizes must match! More... | |
void | deepCopy (const IndirectListBase< Face, Addr > &list) |
Copy elements of the given indirect list. Sizes must match! More... | |
SubList< Face > | slice (const label pos, label len=-1) |
Return SubList slice (non-const access) - no range checking. More... | |
const SubList< Face > | slice (const label pos, label len=-1) const |
Return SubList slice (const access) - no range checking. More... | |
SubList< Face > | slice (const labelRange &range) |
Return SubList slice (non-const access) - with range checking. More... | |
const SubList< Face > | slice (const labelRange &range) const |
Return SubList slice (const access) - with range checking. More... | |
Face & | operator[] (const label i) |
Return element of UList. More... | |
const Face & | operator[] (const label i) const |
Return element of constant UList. More... | |
const bool & | operator[] (const label i) const |
UPstream::commsStruct & | operator[] (const label procID) |
const UPstream::commsStruct & | operator[] (const label procID) const |
Foam::UPstream::commsStruct & | operator[] (const label procID) |
const Foam::UPstream::commsStruct & | operator[] (const label procID) const |
operator const Foam::List< Face > & () const | |
Allow cast to a const List<T>&. More... | |
iterator | begin () noexcept |
Return an iterator to begin traversing the UList. More... | |
iterator | begin (const label i) noexcept |
Return iterator at offset i from begin, clamped to [0,size] range. More... | |
const_iterator | begin () const noexcept |
Return const_iterator to begin traversing the constant UList. More... | |
const_iterator | begin (const label i) const noexcept |
Return const_iterator at offset i from begin, clamped to [0,size] range. More... | |
iterator | end () noexcept |
Return an iterator to end traversing the UList. More... | |
const_iterator | end () const noexcept |
Return const_iterator to end traversing the constant UList. More... | |
const_iterator | cbegin () const noexcept |
Return const_iterator to begin traversing the constant UList. More... | |
const_iterator | cbegin (const label i) const noexcept |
Return const_iterator at offset i from begin, clamped to [0,size] range. More... | |
const_iterator | cend () const noexcept |
Return const_iterator to end traversing the constant UList. More... | |
reverse_iterator | rbegin () |
Return reverse_iterator to begin reverse traversing the UList. More... | |
const_reverse_iterator | rbegin () const |
Return const_reverse_iterator to begin reverse traversing the UList. More... | |
reverse_iterator | rend () |
Return reverse_iterator to end reverse traversing the UList. More... | |
const_reverse_iterator | rend () const |
Return const_reverse_iterator to end reverse traversing the UList. More... | |
const_reverse_iterator | crbegin () const |
Return const_reverse_iterator to begin reverse traversing the UList. More... | |
const_reverse_iterator | crend () const |
Return const_reverse_iterator to end reverse traversing the UList. More... | |
bool | empty () const noexcept |
True if List is empty (ie, size() is zero) More... | |
label | capacity () const noexcept |
Size of the underlying storage. More... | |
void | swap (UList< Face > &list) noexcept |
Swap content with another UList of the same type in constant time. More... | |
bool | operator== (const UList< Face > &list) const |
Equality operation on ULists of the same type. More... | |
bool | operator!= (const UList< Face > &list) const |
The opposite of the equality operation. Takes linear time. More... | |
bool | operator< (const UList< Face > &list) const |
Compare two ULists lexicographically. Takes linear time. More... | |
bool | operator> (const UList< Face > &list) const |
Compare two ULists lexicographically. Takes linear time. More... | |
bool | operator<= (const UList< Face > &list) const |
Return true if !(a > b). Takes linear time. More... | |
bool | operator>= (const UList< Face > &list) const |
Return true if !(a < b). Takes linear time. More... | |
Istream & | readList (Istream &is) |
Read List contents from Istream. More... | |
Ostream & | writeList (Ostream &os, const label shortLen=0) const |
Write List, with line-breaks in ASCII when length exceeds shortLen. More... | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | test (const label i) const |
Test bool value at specified position, always false for out-of-range access. More... | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | get (const label i) const |
Return bool value at specified position, always false for out-of-range access. More... | |
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | unset (const label i) |
Unset the bool entry at specified position, always false for out-of-range access. More... | |
Face & | first () |
Access first element of the list, position [0]. More... | |
const Face & | first () const |
Access first element of the list. More... | |
Face & | last () |
Access last element of the list, position [size()-1]. More... | |
const Face & | last () const |
Access last element of the list, position [size()-1]. More... | |
bool | found (const Face &val, label pos=0) const |
Same as contains() More... | |
Public Member Functions inherited from surfaceFormatsCore | |
surfaceFormatsCore ()=default | |
Default construct. More... | |
virtual | ~surfaceFormatsCore ()=default |
Destructor. More... | |
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 interpolateToPoints=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 noexcept |
Access to the underlying mesh. More... | |
const word & | name () const noexcept |
Name of surface. More... | |
bool | enabled () const noexcept |
Surface is enabled. More... | |
bool | invariant () const noexcept |
Surface is invariant with geometry change (caution) More... | |
bool | isPointData () const noexcept |
Using interpolation to surface points. More... | |
virtual bool | isPointData (const bool on) |
Change point/cell representation, may trigger an expire(). More... | |
scalar | area () const |
The total surface area. More... | |
virtual bool | hasFaceIds () const |
If element ids/order of the original surface are available. More... | |
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... | |
virtual void | rename (const word &newName) |
Rename. More... | |
bool | interpolate () const noexcept |
Same as isPointData() More... | |
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. More... | |
virtual | ~meshedSurf ()=default |
Destructor. More... | |
virtual const labelList & | faceIds () const |
Per-face identifier (eg, element Id) More... | |
Additional Inherited Members | |
Public Types inherited from MeshedSurface< Face > | |
typedef Face | face_type |
The face type (same as the underlying PrimitivePatch) More... | |
typedef point | point_type |
The point type (same as the underlying PrimitivePatch) More... | |
Public Types inherited from PrimitivePatch<::Foam::List< Face >, pointField > | |
enum | surfaceTopo |
Enumeration defining the surface type. Used in check routines. More... | |
typedef std::remove_reference< ::Foam::List< Face > >::type::value_type | face_type |
The face type. More... | |
typedef std::remove_reference< pointField >::type::value_type | point_type |
The point type. More... | |
typedef ::Foam::List< Face > | FaceListType |
The face list type. More... | |
typedef pointField | PointFieldType |
The point field type. More... | |
typedef face_type | FaceType |
Deprecated(2020-03) prefer face_type typedef. More... | |
Public Types inherited from List< Face > | |
typedef SubList< Face > | subList |
Declare type of subList. More... | |
Public Types inherited from UList< Face > | |
typedef Face | value_type |
The value type the list contains. More... | |
typedef Face * | pointer |
The pointer type for non-const access to value_type items. More... | |
typedef const Face * | const_pointer |
The pointer type for const access to value_type items. More... | |
typedef Face & | reference |
The type used for storing into value_type objects. More... | |
typedef const Face & | const_reference |
The type used for reading from constant value_type objects. More... | |
typedef Face * | iterator |
Random access iterator for traversing a UList. More... | |
typedef const Face * | const_iterator |
Random access iterator for traversing a UList. More... | |
typedef label | size_type |
The type to represent the size of a UList. More... | |
typedef label | difference_type |
The difference between iterator objects. More... | |
typedef std::reverse_iterator< iterator > | reverse_iterator |
Reverse iterator (non-const access) More... | |
typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
Reverse iterator (const access) More... | |
Static Public Member Functions inherited from MeshedSurface< Face > | |
static wordHashSet | readTypes () |
Known readable file-types, without friends or proxies. More... | |
static wordHashSet | writeTypes () |
Known writable file-types, without friends or proxies. More... | |
static bool | canReadType (const word &fileType, bool verbose=false) |
Can we read this file format? Also checks friend types. More... | |
static bool | canWriteType (const word &fileType, bool verbose=false) |
Can we write this file format? Also checks proxy types. More... | |
static bool | canRead (const fileName &name, bool verbose=false) |
Can we read this file format? More... | |
static autoPtr< MeshedSurface > | New (const fileName &name, const word &fileType, bool mandatory=true) |
Read construct from filename with given file type. More... | |
static autoPtr< MeshedSurface > | New (const fileName &name) |
Read construct from filename (file type implicit from extension) More... | |
static void | write (const fileName &name, const MeshedSurface< Face > &surf, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) |
Write to file, selecting writer based on its extension. More... | |
static void | write (const fileName &name, const word &fileType, const MeshedSurface< Face > &surf, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) |
Write to file, selecting writer based on the given extension. More... | |
Static Public Member Functions inherited from List< Face > | |
static const List< Face > & | null () noexcept |
Return a null List (reference to a nullObject). Behaves like an empty List. More... | |
Static Public Member Functions inherited from UList< Face > | |
static const UList< Face > & | null () noexcept |
Return a null UList (reference to a nullObject). Behaves like an empty UList. More... | |
static constexpr label | max_size () noexcept |
The size of the largest possible UList. More... | |
Static Public Member Functions inherited from surfaceFormatsCore | |
static bool | checkSupport (const wordHashSet &available, const word &fileType, const bool verbose=false, const char *functionName=nullptr) |
Verbose checking of fileType in the list of available types. More... | |
static fileName | findFile (const IOobject &io, const bool isGlobal=true) |
Use IOobject information to resolve file to load from, or empty if the file does not exist. More... | |
static fileName | findFile (const IOobject &io, const dictionary &dict, const bool isGlobal=true) |
Use IOobject information to resolve file to load from, or empty if the file does not exist. More... | |
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 surfaceFormatsCore | |
static word | nativeExt |
The file extension corresponding to 'native' surface format. More... | |
Protected Member Functions inherited from sampledPatch | |
const wordRes & | patchNames () const |
The selection (word/regex) of patches. More... | |
const labelList & | patchIDs () const |
The patches selected. More... | |
const labelList & | patchStart () const |
The offset into patchIndex, patchFaceLabels. More... | |
const labelList & | patchIndex () const |
For each face, the patch ID. More... | |
const labelList & | patchFaceLabels () const |
For each face, the patch local face ID. More... | |
Protected Member Functions inherited from MeshedSurface< Face > | |
void | transcribe (MeshedSurface< face > &surf) |
Transfer points/zones from 'face' to other other shapes. More... | |
void | checkZones (const bool verbose=true) |
Sanity check/resizing on zones. More... | |
pointField & | storedPoints () |
Non-const access to global points. More... | |
List< Face > & | storedFaces () |
Non-const access to the faces. More... | |
labelList & | storedFaceIds () |
Non-const access to face ids. More... | |
surfZoneList & | storedZones () |
Non-const access to the zones. More... | |
void | sortFacesAndStore (DynamicList< Face > &unsortedFaces, DynamicList< label > &zoneIds, DynamicList< label > &elemIds, bool sorted) |
Sort faces by zones and store sorted faces. More... | |
template<> | |
void | transcribe (MeshedSurface< face > &surf) |
template<> | |
void | transcribe (MeshedSurface< face > &surf) |
template<> | |
void | transcribe (MeshedSurface< face > &surf) |
Protected Member Functions inherited from UList< Face > | |
void | setAddressableSize (const label n) noexcept |
Set addressed size to be inconsistent with allocated storage. More... | |
void | size (const label n) |
Older name for setAddressableSize. More... | |
void | writeEntry (Ostream &os) const |
Write the UList with its compound type. More... | |
void | writeEntry (Ostream &os) const |
Character list writeEntry. More... | |
void | writeEntry (Ostream &os) const |
labelRange | validateRange (const labelRange &requestedRange) const |
Return a validated (start,size) subset range, which means that it always addresses a valid section of the list. More... | |
void | fill_uniform (const Face &val) |
Assign all entries to the given value. More... | |
void | fill_uniform (const Foam::zero) |
Assign all entries to zero. More... | |
UList< Face > & | operator= (const UList< Face > &)=delete |
No copy assignment (default: shallow copy) More... | |
void | operator= (const Foam::zero) |
Character list assign zero - avoids Foam::zero casting ambiguities. More... | |
void | operator= (const Foam::zero) |
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 surfaceFormatsCore | |
static string | getLineNoComment (ISstream &is, const char comment='#') |
Read non-empty and non-comment line. More... | |
template<class Container > | |
static List< surfZone > | oneZone (const Container &container, const word &name="zone0") |
Return a surfZone list with a single entry, the size of which corresponds to that of the container. More... | |
static labelList | getSelectedPatches (const surfZoneList &patches, const wordRes &allow, const wordRes &deny=wordRes()) |
Return ids for zone/patch that match by name. More... | |
static fileName | relativeFilePath (const IOobject &io, const fileName &f, const bool isGlobal=true) |
Return fileName. More... | |
static fileName | checkFile (const IOobject &io, const bool isGlobal=true) |
Return fileName to load IOobject from. More... | |
static fileName | checkFile (const IOobject &io, const dictionary &dict, const bool isGlobal=true) |
Return fileName to load IOobject from. 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, const Type &defaultValue=Type(Zero)) |
Loop for sampling volume elements to faces. More... | |
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. More... | |
template<class Type > | |
static tmp< VolumeField< Type > > | pointAverage (const PointField< Type > &pfld) |
Create cell values by averaging the point values. More... | |
Variation of sampledPatch that samples the internalField (at a given normal distance from the patch) instead of the patchField. Note:
This is often embedded as part of a sampled surfaces function object.
surfaces { surface1 { type patchInternalField; patches (inlet "outlet.*"); offsetMode normal; distance 0.05; } }
Where the sub-entries comprise:
Property | Description | Required | Default |
---|---|---|---|
type | patchInternalField | yes | |
patches | patch selection as word/regex list | yes | |
offsetMode | normal/uniform/nonuniform | no | normal |
distance | distance for normal offset | partly | |
offset | point offset for uniform offset | partly | |
offsets | point offsets for nonuniform offset | partly |
Definition at line 116 of file sampledPatchInternalField.H.
sampledPatchInternalField | ( | const word & | name, |
const polyMesh & | mesh, | ||
const dictionary & | dict | ||
) |
Construct from dictionary.
Definition at line 48 of file sampledPatchInternalField.C.
References dict, Foam::distance(), forAll, mesh, Foam::mode(), Foam::Detail::ListPolicy::NONUNIFORM, patchIDs(), and Foam::Detail::ListPolicy::UNIFORM.
|
virtualdefault |
Destructor.
TypeName | ( | "sampledPatchInternalField" | ) |
Runtime type information.
|
virtual |
Sample boundary of volume field onto surface faces.
Reimplemented from sampledPatch.
Definition at line 134 of file sampledPatchInternalField.C.
|
virtual |
Sample boundary of volume field onto surface faces.
Reimplemented from sampledPatch.
Definition at line 143 of file sampledPatchInternalField.C.
|
virtual |
Sample boundary of volume field onto surface faces.
Reimplemented from sampledPatch.
Definition at line 152 of file sampledPatchInternalField.C.
|
virtual |
Sample boundary of volume field onto surface faces.
Reimplemented from sampledPatch.
Definition at line 161 of file sampledPatchInternalField.C.
|
virtual |
Sample boundary of volume field onto surface faces.
Reimplemented from sampledPatch.
Definition at line 170 of file sampledPatchInternalField.C.
|
virtual |
Interpolate boundary of volume field onto surface points.
Reimplemented from sampledPatch.
Definition at line 179 of file sampledPatchInternalField.C.
|
virtual |
Interpolate boundary of volume field onto surface points.
Reimplemented from sampledPatch.
Definition at line 188 of file sampledPatchInternalField.C.
|
virtual |
Interpolate boundary of volume field onto surface points.
Reimplemented from sampledPatch.
Definition at line 198 of file sampledPatchInternalField.C.
|
virtual |
Interpolate boundary of volume field onto surface points.
Reimplemented from sampledPatch.
Definition at line 207 of file sampledPatchInternalField.C.
|
virtual |
Interpolate boundary of volume field onto surface points.
Reimplemented from sampledPatch.
Definition at line 216 of file sampledPatchInternalField.C.
|
virtual |
Print information.
Reimplemented from sampledPatch.
Definition at line 224 of file sampledPatchInternalField.C.
References sampledPatch::faces(), sampledSurface::name(), os(), sampledPatch::patchNames(), sampledPatch::points(), and UList< T >::size().
Foam::tmp<Foam::Field<Type> > sampleOnFaces | ( | const interpolation< Type > & | sampler | ) | const |
Definition at line 31 of file sampledPatchInternalFieldTemplates.C.
References stdFoam::end(), forAll, Field< Type >::map(), Foam::New(), interpolation< Type >::psi(), and Foam::HashTableOps::values().
Foam::tmp<Foam::Field<Type> > sampleOnPoints | ( | const interpolation< Type > & | interpolator | ) | const |
Definition at line 68 of file sampledPatchInternalFieldTemplates.C.
References mapDistribute::distribute(), forAll, interpolation< Type >::interpolate(), Foam::max(), mesh, patchId(), patchIDs(), points, pp(), mapDistribute::reverseDistribute(), samples(), and UList< Type >::size().