refinementFeatures Class Reference

Encapsulates queries for features. More...

Inheritance diagram for refinementFeatures:
[legend]
Collaboration diagram for refinementFeatures:
[legend]

Public Member Functions

 refinementFeatures (const objectRegistry &io, const PtrList< dictionary > &featDicts, const bool dryRun=false)
 Construct from description. More...
 
const labelListListlevels () const
 Per featureEdgeMesh the list of level. More...
 
const List< scalarField > & distances () const
 Per featureEdgeMesh the list of ranges. More...
 
scalar maxDistance () const
 Highest distance of all features. More...
 
void findNearestEdge (const pointField &samples, const scalarField &nearestDistSqr, labelList &nearFeature, List< pointIndexHit > &nearInfo, vectorField &nearNormal) const
 Find nearest point on nearest feature edge. Sets. More...
 
void findNearestRegionEdge (const pointField &samples, const scalarField &nearestDistSqr, labelList &nearFeature, List< pointIndexHit > &nearInfo, vectorField &nearNormal) const
 Find nearest point on nearest region edge. Sets. More...
 
void findNearestPoint (const pointField &samples, const scalarField &nearestDistSqr, labelList &nearFeature, List< pointIndexHit > &nearInfo) const
 Find nearest feature point. Sets. More...
 
void findHigherLevel (const pointField &pt, const labelList &ptLevel, labelList &maxLevel) const
 Find shell level higher than ptLevel. More...
 
bool checkSizes (const scalar maxRatio, const boundBox &meshBb, const bool report, Ostream &os) const
 Check sizes - return true if error and stream to os. More...
 
- Public Member Functions inherited from PtrList< extendedFeatureEdgeMesh >
constexpr PtrList () noexcept
 Default construct. More...
 
 PtrList (const label len)
 Construct with specified size, each element initialized to nullptr. More...
 
 PtrList (const PtrList< extendedFeatureEdgeMesh > &list)
 Copy construct using 'clone()' method on each element. More...
 
 PtrList (PtrList< extendedFeatureEdgeMesh > &&list)
 Move construct. More...
 
 PtrList (UList< extendedFeatureEdgeMesh * > &list)
 Take ownership of pointers in the list, set old pointers to null. More...
 
 PtrList (const PtrList< extendedFeatureEdgeMesh > &list, const CloneArg &cloneArgs)
 Copy construct using 'clone()' method on each element. More...
 
 PtrList (PtrList< extendedFeatureEdgeMesh > &list, bool reuse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< extendedFeatureEdgeMesh > &list)
 Copy construct using 'clone()' on each element of SLPtrList<T> More...
 
 PtrList (Istream &is, const INew &inew)
 Construct from Istream using given Istream constructor class. More...
 
 PtrList (Istream &is)
 Construct from Istream using default Istream constructor class. More...
 
 ~PtrList ()
 Destructor. More...
 
PtrList< extendedFeatureEdgeMeshclone (Args &&... args) const
 Make a copy by cloning each of the list elements. More...
 
Foam::PtrList< extendedFeatureEdgeMeshclone (Args &&... args) const
 
const extendedFeatureEdgeMeshset (const label i) const
 
autoPtr< extendedFeatureEdgeMeshset (const label i, extendedFeatureEdgeMesh *ptr)
 Set element to given pointer and return old element (can be null) More...
 
autoPtr< extendedFeatureEdgeMeshset (const label i, autoPtr< extendedFeatureEdgeMesh > &ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< extendedFeatureEdgeMeshset (const label i, autoPtr< extendedFeatureEdgeMesh > &&ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< extendedFeatureEdgeMeshset (const label i, std::unique_ptr< extendedFeatureEdgeMesh > &&ptr)
 Set element to given unique_ptr and return old element. More...
 
autoPtr< extendedFeatureEdgeMeshset (const label i, const refPtr< extendedFeatureEdgeMesh > &ptr)
 Set element to given refPtr and return old element. More...
 
autoPtr< extendedFeatureEdgeMeshset (const label i, const tmp< extendedFeatureEdgeMesh > &ptr)
 Set element to given tmp and return old element. More...
 
void clear ()
 Clear the PtrList. Delete allocated entries and set size to zero. More...
 
void resize (const label newLen)
 Adjust size of PtrList. More...
 
void setSize (const label newLen)
 Same as resize() More...
 
void emplace_append (Args &&... args)
 Construct and append an element to the end of the list. More...
 
void append (extendedFeatureEdgeMesh *ptr)
 Append an element to the end of the list. More...
 
void append (autoPtr< extendedFeatureEdgeMesh > &ptr)
 Move append an element to the end of the list. More...
 
void append (autoPtr< extendedFeatureEdgeMesh > &&ptr)
 Move append an element to the end of the list. More...
 
void append (std::unique_ptr< extendedFeatureEdgeMesh > &&ptr)
 Move append an element to the end of the list. More...
 
void append (const refPtr< extendedFeatureEdgeMesh > &ptr)
 Move or clone append a refPtr to the end of the list. More...
 
void append (const tmp< extendedFeatureEdgeMesh > &ptr)
 Move or clone append a tmp to the end of the list. More...
 
void append (PtrList< extendedFeatureEdgeMesh > &&other)
 Move append another list to the end of this list. More...
 
autoPtr< extendedFeatureEdgeMeshemplace (const label i, Args &&... args)
 Construct and set an element. More...
 
Foam::autoPtr< extendedFeatureEdgeMeshemplace (const label i, Args &&... args)
 
autoPtr< extendedFeatureEdgeMeshrelease (const label i)
 Release ownership of the pointer at the given position. More...
 
void transfer (PtrList< extendedFeatureEdgeMesh > &list)
 Transfer into this list and annul the argument list. More...
 
void operator= (const PtrList< extendedFeatureEdgeMesh > &list)
 Copy assignment. More...
 
void operator= (PtrList< extendedFeatureEdgeMesh > &&list)
 Move assignment. More...
 
- Public Member Functions inherited from UPtrList< T >
constexpr UPtrList () noexcept
 Default construct. More...
 
 UPtrList (const label len)
 Construct with specified size, each element initialized to nullptr. More...
 
 UPtrList (const UPtrList< T > &list)
 Copy construct (shallow copies addresses) More...
 
 UPtrList (UPtrList< T > &&list)
 Move construct. More...
 
 UPtrList (UPtrList< T > &list, bool reuse)
 Construct as shallow copy or re-use as specified. More...
 
 UPtrList (PtrList< T > &list)
 Shallow copy from PtrList. More...
 
 UPtrList (const UList< T * > &list)
 Construct from UList of pointers (shallow copy) More...
 
 UPtrList (UList< T > &list)
 Construct from UList, taking the address of each list element. More...
 
label size () const noexcept
 The number of elements in the list. More...
 
bool empty () const noexcept
 True if the list is empty (ie, size() is zero) More...
 
Tfirst ()
 Return reference to the first element of the list. More...
 
const Tfirst () const
 Return reference to first element of the list. More...
 
Tlast ()
 Return reference to the last element of the list. More...
 
const Tlast () const
 Return reference to the last element of the list. More...
 
const Ttest (const label i) const
 
Tget (const label i)
 
const Tget (const label i) const
 
const Tset (const label i) const
 
void clear ()
 Set list size to zero. More...
 
void resize (const label newLen)
 Change the size of the list. More...
 
void setSize (const label n)
 Alias for resize() More...
 
label squeezeNull ()
 Squeeze out intermediate nullptr entries in the list of pointers. More...
 
void append (T *ptr)
 Append an element to the end of the list. More...
 
void append (UPtrList< T > &&other)
 Move append another list to the end of this list. More...
 
void swap (UPtrList< T > &list)
 Swap content. More...
 
void transfer (UPtrList< T > &list)
 Transfer contents into this list and annul the argument. More...
 
Tset (const label i, T *ptr)
 
void reorder (const labelUList &oldToNew, const bool check=false)
 
void sortOrder (const labelUList &order, const bool check=false)
 
void checkNonNull () const
 Check and raise FatalError if any nullptr exists in the list. More...
 
const Toperator[] (const label i) const
 Return const reference to the element. More...
 
Toperator[] (const label i)
 Return reference to the element. More...
 
const Toperator() (const label i) const
 Return const pointer to the element - same as get(). More...
 
void operator= (const UPtrList< T > &list)
 Copy assignment (shallow copies addresses) More...
 
void operator= (UPtrList< T > &&list)
 Move assignment. More...
 
T ** begin_ptr () noexcept
 Iterator to begin of raw pointers traversal (use with caution) More...
 
T ** end_ptr () noexcept
 Iterator beyond end of raw pointers traversal (use with caution) More...
 
iterator begin () noexcept
 Return an iterator to begin of UPtrList traversal. More...
 
iterator end () noexcept
 Return iterator beyond end of UPtrList traversal. More...
 
const_iterator cbegin () const noexcept
 Return const_iterator to begin of UPtrList traversal. More...
 
const_iterator cend () const noexcept
 Return const_iterator beyond end of UPtrList traversal. More...
 
const_iterator begin () const noexcept
 Return const_iterator to begin of UPtrList traversal. More...
 
const_iterator end () const noexcept
 Return const_iterator beyond end of UPtrList traversal. More...
 

Protected Member Functions

const PtrList< indexedOctree< treeDataEdge > > & edgeTrees () const
 
const PtrList< indexedOctree< treeDataPoint > > & pointTrees () const
 
const PtrList< indexedOctree< treeDataEdge > > & regionEdgeTrees () const
 
- Protected Member Functions inherited from PtrList< extendedFeatureEdgeMesh >
void readIstream (Istream &is, const INew &inew)
 Read from Istream using Istream constructor class. More...
 
void free ()
 Delete the allocated entries, but retain the list size. More...
 
- Protected Member Functions inherited from UPtrList< T >
void setAddressableSize (const label n) noexcept
 Adjust addressable size. More...
 
 UPtrList (Detail::PtrListDetail< T > &&ptrs)
 Low-level move construct. More...
 

Additional Inherited Members

- Public Types inherited from UPtrList< T >
typedef T value_type
 Type of values the list contains. More...
 
typedef Treference
 A non-const reference to the value_type. More...
 
typedef const Tconst_reference
 A const reference to the value_type. More...
 
- Protected Attributes inherited from UPtrList< T >
Detail::PtrListDetail< Tptrs_
 The list of pointers. More...
 

Detailed Description

Encapsulates queries for features.

Source files

Definition at line 53 of file refinementFeatures.H.

Constructor & Destructor Documentation

◆ refinementFeatures()

refinementFeatures ( const objectRegistry io,
const PtrList< dictionary > &  featDicts,
const bool  dryRun = false 
)

Construct from description.

Definition at line 472 of file refinementFeatures.C.

References forAll, and io().

Here is the call graph for this function:

Member Function Documentation

◆ edgeTrees()

const PtrList< indexedOctree< treeDataEdge > > & edgeTrees ( ) const
inlineprotected

Definition at line 98 of file refinementFeatures.H.

◆ pointTrees()

const PtrList< indexedOctree< treeDataPoint > > & pointTrees ( ) const
inlineprotected

Definition at line 103 of file refinementFeatures.H.

◆ regionEdgeTrees()

const Foam::PtrList< Foam::indexedOctree< Foam::treeDataEdge > > & regionEdgeTrees ( ) const
protected

Definition at line 417 of file refinementFeatures.C.

References e, edgeMesh::edges(), treeBoundBox::extend(), forAll, boundBox::max(), boundBox::min(), points, edgeMesh::points(), extendedEdgeMesh::regionEdges(), rndGen, and PtrList< T >::set().

Here is the call graph for this function:

◆ levels()

const labelListList & levels ( ) const
inline

Per featureEdgeMesh the list of level.

Definition at line 129 of file refinementFeatures.H.

Referenced by snappyVoxelMeshDriver::snappyVoxelMeshDriver().

Here is the caller graph for this function:

◆ distances()

const List< scalarField > & distances ( ) const
inline

Per featureEdgeMesh the list of ranges.

Definition at line 135 of file refinementFeatures.H.

◆ maxDistance()

Foam::scalar maxDistance ( ) const

Highest distance of all features.

Definition at line 881 of file refinementFeatures.C.

References forAll, and Foam::max().

Here is the call graph for this function:

◆ findNearestEdge()

void findNearestEdge ( const pointField samples,
const scalarField nearestDistSqr,
labelList nearFeature,
List< pointIndexHit > &  nearInfo,
vectorField nearNormal 
) const

Find nearest point on nearest feature edge. Sets.

  • nearFeature: index of feature mesh

nearInfo : location on feature edge and edge index (note: not feature edge index but index into edges() directly)

  • nearNormal : local feature edge normal

Definition at line 639 of file refinementFeatures.C.

References e, treeDataEdge::edges(), forAll, PointIndexHit< PointType >::hit(), PointIndexHit< PointType >::hitPoint(), PointIndexHit< PointType >::index(), Foam::magSqr(), treeDataEdge::points(), samples(), List< T >::setSize(), indexedOctree< Type >::shapes(), UList< T >::size(), and Foam::Zero.

Here is the call graph for this function:

◆ findNearestRegionEdge()

void findNearestRegionEdge ( const pointField samples,
const scalarField nearestDistSqr,
labelList nearFeature,
List< pointIndexHit > &  nearInfo,
vectorField nearNormal 
) const

Find nearest point on nearest region edge. Sets.

  • nearFeature: index of feature mesh

nearInfo : location on feature edge and edge index (note: not feature edge index but index into edges() directly)

  • nearNormal : local feature edge normal

Definition at line 698 of file refinementFeatures.C.

References e, treeDataEdge::edges(), forAll, PointIndexHit< PointType >::hit(), PointIndexHit< PointType >::hitPoint(), PointIndexHit< PointType >::index(), Foam::magSqr(), treeDataEdge::points(), samples(), List< T >::setSize(), indexedOctree< Type >::shapes(), UList< T >::size(), and Foam::Zero.

Here is the call graph for this function:

◆ findNearestPoint()

void findNearestPoint ( const pointField samples,
const scalarField nearestDistSqr,
labelList nearFeature,
List< pointIndexHit > &  nearInfo 
) const

Find nearest feature point. Sets.

  • nearFeature: index of feature mesh

nearInfo : location on feature point and point index. (note: not index into shapes().pointLabels() but index into points() directly)

Definition at line 813 of file refinementFeatures.C.

References forAll, PointIndexHit< PointType >::hit(), PointIndexHit< PointType >::hitPoint(), PointIndexHit< PointType >::index(), Foam::magSqr(), samples(), List< T >::setSize(), indexedOctree< Type >::shapes(), and UList< T >::size().

Here is the call graph for this function:

◆ findHigherLevel()

void findHigherLevel ( const pointField pt,
const labelList ptLevel,
labelList maxLevel 
) const

Find shell level higher than ptLevel.

Definition at line 864 of file refinementFeatures.C.

References forAll.

◆ checkSizes()

bool checkSizes ( const scalar  maxRatio,
const boundBox meshBb,
const bool  report,
Ostream os 
) const

Check sizes - return true if error and stream to os.

Definition at line 569 of file refinementFeatures.C.

References Foam::endl(), forAll, boundBox::mag(), meshBb(), IOobject::name(), Foam::nl, os(), edgeMesh::points(), and Foam::returnReduce().

Here is the call graph for this function:

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