nearWallDist Class Reference

Distance calculation for cells with face on a wall. Searches pointNeighbours to find closest. More...

Inheritance diagram for nearWallDist:
Collaboration diagram for nearWallDist:

Public Member Functions

 nearWallDist (const fvMesh &mesh)
 Construct from components. More...
 
virtual ~nearWallDist ()
 Destructor. More...
 
const volScalarField::Boundaryy () const
 
virtual void correct ()
 Correct for mesh geom/topo changes. More...
 
- Public Member Functions inherited from GeometricBoundaryField< Type, PatchField, GeoMesh >
 GeometricBoundaryField (const BoundaryMesh &bmesh)
 Construct from a BoundaryMesh, setting patches later. More...
 
 GeometricBoundaryField (const BoundaryMesh &bmesh, const DimensionedField< Type, GeoMesh > &field, const word &patchFieldType=PatchField< Type >::calculatedType())
 Construct from a BoundaryMesh, reference to the internal field and a patch type. More...
 
 GeometricBoundaryField (const BoundaryMesh &bmesh, const DimensionedField< Type, GeoMesh > &field, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
 Construct from a BoundaryMesh, reference to the internal field and a wordList of patch types and optional the actual patch types (to override constraint patches) More...
 
 GeometricBoundaryField (const BoundaryMesh &bmesh, const DimensionedField< Type, GeoMesh > &field, const PtrList< PatchField< Type >> &ptfl)
 Construct from a BoundaryMesh, reference to the internal field and a PtrList<PatchField<Type>> (to be cloned) More...
 
 GeometricBoundaryField (const DimensionedField< Type, GeoMesh > &field, const GeometricBoundaryField< Type, PatchField, GeoMesh > &btf)
 Construct as copy, setting the reference to the internal field. More...
 
 GeometricBoundaryField (const DimensionedField< Type, GeoMesh > &field, const GeometricBoundaryField< Type, PatchField, GeoMesh > &btf, const labelList &patchIDs, const word &patchFieldName)
 Construct as copy, setting the reference to the internal field and resetting type of field for given patch IDs. More...
 
 GeometricBoundaryField (const GeometricBoundaryField &btf)
 Copy construct. More...
 
 GeometricBoundaryField (const BoundaryMesh &bmesh, const DimensionedField< Type, GeoMesh > &field, const dictionary &dict)
 Construct from dictionary. More...
 
void readField (const DimensionedField< Type, GeoMesh > &field, const dictionary &dict)
 Read the boundary field. More...
 
void updateCoeffs ()
 Update the boundary condition coefficients. More...
 
void evaluate ()
 Evaluate boundary conditions. More...
 
void evaluateLocal ()
 Evaluate boundary conditions after change in local values. More...
 
template<class CoupledPatchType >
void evaluateCoupled ()
 Evaluate boundary conditions on a subset of coupled patches. More...
 
void evaluateSelected (const UList< label > &patchIDs)
 Evaluate boundary conditions for selected patches. More...
 
wordList types () const
 Return a list of the patch types. More...
 
GeometricBoundaryField boundaryInternalField () const
 Return boundary field of values neighbouring the boundary. More...
 
LduInterfaceFieldPtrsList< Type > interfaces () const
 Return a list of pointers for each patch field with only those pointing to interfaces being set. More...
 
lduInterfaceFieldPtrsList scalarInterfaces () const
 Return a list of pointers for each patch field with only those pointing to interfaces being set. More...
 
void writeEntry (const word &keyword, Ostream &os) const
 Write boundary field as dictionary entry. More...
 
void writeEntries (Ostream &os) const
 Write dictionary entries of the individual boundary fields. More...
 
bool check () const
 Helper: check if field has been evaluated. See instantiations. More...
 
void operator= (const GeometricBoundaryField &bf)
 Copy assignment from GeometricBoundaryField. More...
 
void operator= (const FieldField< PatchField, Type > &bf)
 Copy assignment from FieldField<PatchField, Type> More...
 
void operator= (const Type &val)
 Assignment to uniform value. More...
 
void operator== (const GeometricBoundaryField &bf)
 Forced assignment from GeometricBoundaryField. More...
 
void operator== (const FieldField< PatchField, Type > &bf)
 Forced assignment from FieldField<PatchField, Type> More...
 
void operator== (const Type &val)
 Forced assignment to uniform value. More...
 
bool operator!= (const GeometricBoundaryField &)=delete
 
bool operator!= (const FieldField< PatchField, Type > &)=delete
 
bool operator!= (const Type &)=delete
 
template<>
bool check () const
 
template<>
bool check () const
 
template<>
bool check () const
 
template<>
bool check () const
 
template<>
bool check () const
 
template<>
bool check () const
 
template<>
bool check () const
 
template<>
bool check () const
 
template<>
bool check () const
 
template<>
bool check () const
 
template<>
bool check () const
 
template<>
bool check () const
 
template<>
bool check () const
 
template<>
bool check () const
 
template<>
bool check () const
 
template<>
bool check () const
 
template<>
bool check () const
 
template<>
bool check () const
 
template<>
bool check () const
 
template<>
bool check () const
 
- Public Member Functions inherited from FieldField< PatchField, Type >
constexpr FieldField () noexcept
 Construct null. More...
 
 FieldField (const label size)
 Construct given size. More...
 
 FieldField (const word &type, const FieldField< PatchField, Type > &ff)
 Clone construct with new type. More...
 
 FieldField (const FieldField< PatchField, Type > &ff)
 Copy construct, cloning each element. More...
 
 FieldField (FieldField< PatchField, Type > &&ff)
 Move construct. More...
 
 FieldField (FieldField< PatchField, Type > &ff, bool reuse)
 Construct as copy or re-use as specified. More...
 
 FieldField (const PtrList< PatchField< Type >> &list)
 Copy construct from PtrList. More...
 
 FieldField (PtrList< PatchField< Type >> &&list)
 Move construct from PtrList. More...
 
 FieldField (const tmp< FieldField< PatchField, Type >> &tf)
 Move/copy construct from tmp<FieldField> More...
 
 FieldField (Istream &is)
 Construct from Istream. More...
 
tmp< FieldField< PatchField, Type > > clone () const
 Clone. More...
 
void negate ()
 Negate this field. See notes in Field. More...
 
void normalise ()
 Normalise this field. See notes in Field. More...
 
tmp< FieldField< PatchField, cmptType > > component (const direction) const
 Return a component field of the field. More...
 
void replace (const direction, const FieldField< PatchField, cmptType > &)
 Replace a component field of the field. More...
 
void replace (const direction, const cmptType &)
 Replace a component field of the field. More...
 
void clamp_min (const Type &lower)
 Impose lower (floor) clamp on the field values (in-place) More...
 
void clamp_max (const Type &upper)
 Impose upper (ceiling) clamp on the field values (in-place) More...
 
void clamp_range (const Type &lower, const Type &upper)
 Clamp field values (in-place) to the specified range. More...
 
void clamp_range (const MinMax< Type > &range)
 Clamp field values (in-place) to the specified range. More...
 
tmp< FieldField< PatchField, Type > > T () const
 Return the field transpose (only defined for second rank tensors) More...
 
const Type & operator[] (const labelPair &index) const
 Const access to a single field element via (fieldi, elemi) More...
 
Type & operator[] (const labelPair &index)
 Non-const access to a single field element via (fieldi, elemi) More...
 
void operator= (const FieldField< PatchField, Type > &)
 Copy assignment. More...
 
void operator= (FieldField< PatchField, Type > &&)
 Move assignment. More...
 
void operator= (const tmp< FieldField< PatchField, Type >> &)
 Move or clone assignment. More...
 
void operator= (const Type &val)
 Assign uniform value. More...
 
void operator= (const Foam::zero)
 Assign uniform zero. More...
 
void operator+= (const FieldField< PatchField, Type > &)
 
void operator+= (const tmp< FieldField< PatchField, Type >> &)
 
void operator+= (const Type &)
 
void operator-= (const FieldField< PatchField, Type > &)
 
void operator-= (const tmp< FieldField< PatchField, Type >> &)
 
void operator-= (const Type &)
 
void operator*= (const FieldField< PatchField, scalar > &)
 
void operator*= (const tmp< FieldField< PatchField, scalar >> &)
 
void operator*= (const scalar &)
 
void operator/= (const FieldField< PatchField, scalar > &)
 
void operator/= (const tmp< FieldField< PatchField, scalar >> &)
 
void operator/= (const scalar &)
 
- Public Member Functions inherited from refCount
constexpr refCount () noexcept
 Default construct, initializing count to 0. More...
 
int use_count () const noexcept
 Return the current reference count. More...
 
bool unique () const noexcept
 Return true if the reference count is zero. More...
 
void operator++ () noexcept
 Increment the reference count. More...
 
void operator++ (int) noexcept
 Increment the reference count. More...
 
void operator-- () noexcept
 Decrement the reference count. More...
 
void operator-- (int) noexcept
 Decrement the reference count. More...
 
- Public Member Functions inherited from PtrList< PatchField< Type > >
constexpr PtrList () noexcept
 Default construct. More...
 
 PtrList (const label len)
 Construct with specified size, each element initialized to nullptr. More...
 
 PtrList (const PtrList< PatchField< Type > > &list)
 Copy construct using 'clone()' method on each element. More...
 
 PtrList (PtrList< PatchField< Type > > &&list) noexcept
 Move construct. More...
 
 PtrList (UList< PatchField< Type > * > &list)
 Take ownership of pointers in the list, set old pointers to null. More...
 
 PtrList (const PtrList< PatchField< Type > > &list, const CloneArg &cloneArgs)
 Copy construct using 'clone()' method on each element. More...
 
 PtrList (PtrList< PatchField< Type > > &list, bool reuse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< PatchField< Type > > &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. Frees all pointers. More...
 
PtrList< PatchField< Type > > clone (Args &&... args) const
 Make a copy by cloning each of the list elements. More...
 
Foam::PtrList< PatchField< Type > > clone (Args &&... args) const
 
const PatchField< Type > * set (const label i) const
 Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...
 
autoPtr< PatchField< Type > > set (const label i, PatchField< Type > *ptr)
 Set element to given pointer and return old element (can be null) More...
 
autoPtr< PatchField< Type > > set (const label i, std::unique_ptr< PatchField< Type > > &&ptr)
 Set element to given unique_ptr and return old element. More...
 
autoPtr< PatchField< Type > > set (const label i, autoPtr< PatchField< Type > > &&ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< PatchField< Type > > set (const label i, const refPtr< PatchField< Type > > &ptr)
 Set element to given refPtr and return old element. More...
 
autoPtr< PatchField< Type > > set (const label i, const tmp< PatchField< Type > > &ptr)
 Set element to given tmp and return old element. More...
 
autoPtr< PatchField< Type > > set (const label i, autoPtr< PatchField< Type > > &ptr)
 Set element to given autoPtr and return old element. More...
 
void clear ()
 Clear the PtrList. Delete allocated entries and set size to zero. More...
 
void free ()
 Free memory and nullify all entries. Does not change the list size. More...
 
void resize (const label newLen)
 Adjust size of PtrList. More...
 
void resize_null (const label newLen)
 Set the addressed list to the given size, deleting all existing entries. Afterwards the list contains all nullptr entries. More...
 
PatchField< Type > & emplace_back (Args &&... args)
 Construct and append an element to the end of the list, return reference to the new list element. More...
 
void push_back (PatchField< Type > *ptr)
 Append an element to the end of the list. More...
 
void push_back (std::unique_ptr< PatchField< Type > > &&ptr)
 Move append an element to the end of the list. More...
 
void push_back (autoPtr< PatchField< Type > > &&ptr)
 Move append an element to the end of the list. More...
 
void push_back (const refPtr< PatchField< Type > > &ptr)
 Move or clone append a refPtr to the end of the list. More...
 
void push_back (const tmp< PatchField< Type > > &ptr)
 Move or clone append a tmp to the end of the list. More...
 
void push_back (PtrList< PatchField< Type > > &&other)
 Move append another list to the end of this list. More...
 
void push_back (autoPtr< PatchField< Type > > &ptr)=delete
 Disallow push_back with autoPtr without std::move. More...
 
PatchField< Type > & emplace_set (const label i, Args &&... args)
 Construct and set a new element at given position, (discard old element at that location). More...
 
PatchField< Type > & emplace (const label i, Args &&... args)
 Same as emplace_set() More...
 
PatchField< Type > & try_emplace (const label i, Args &&... args)
 Like emplace_set() but will not overwrite an occupied (non-null) location. More...
 
autoPtr< PatchField< Type > > release (const label i)
 Release ownership of the pointer at the given position. More...
 
void transfer (PtrList< PatchField< Type > > &list)
 Transfer into this list and annul the argument list. More...
 
void operator= (const PtrList< PatchField< Type > > &list)
 Copy assignment. More...
 
void operator= (PtrList< PatchField< Type > > &&list)
 Move assignment. More...
 
void setSize (const label newLen)
 Same as resize() More...
 
void append (autoPtr< PatchField< Type > > &ptr)
 Move append an element to the end of the list. More...
 
void append (PatchField< Type > *ptr)
 Append an element to the end of the list. More...
 
void append (std::unique_ptr< PatchField< Type > > &&ptr)
 Move append an element to the end of the list. More...
 
void append (autoPtr< PatchField< Type > > &&ptr)
 Move append an element to the end of the list. More...
 
void append (const refPtr< PatchField< Type > > &ptr)
 Move or clone append a tmp to the end of the list. More...
 
void append (const tmp< PatchField< Type > > &ptr)
 Move or clone append a tmp to the end of the list. More...
 
void append (PtrList< PatchField< Type > > &&other)
 Move append another list to the end of this list. More...
 
- Public Member Functions inherited from UPtrList< T >
constexpr UPtrList () noexcept=default
 Default construct. More...
 
 UPtrList (const label len)
 Construct with specified size and set all entries to nullptr. More...
 
 UPtrList (const UPtrList< T > &list)
 Copy construct (shallow copies addresses) More...
 
 UPtrList (UPtrList< T > &&list) noexcept
 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...
 
bool empty () const noexcept
 True if the list is empty (ie, size() is zero) More...
 
label size () const noexcept
 The number of entries in the list. More...
 
label capacity () const noexcept
 Size of the underlying storage. More...
 
label count () const noexcept
 The number of non-null entries in the list. More...
 
Tfront ()
 Reference to the first element of the list. More...
 
const Tfront () const
 Reference to first element of the list. More...
 
Tback ()
 Reference to the last element of the list. More...
 
const Tback () const
 Reference to the last element of the list. More...
 
const Ttest (const label i) const
 Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...
 
const Tget (const label i) const
 Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...
 
Tget (const label i)
 Return pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...
 
const Tset (const label i) const
 Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...
 
void clear ()
 Set list size to zero. More...
 
void free ()
 Nullify all entries. Does not change the list size. More...
 
void resize (const label newLen)
 Change the size of the list. Any new entries are nullptr. More...
 
void resize_null (const label newLen)
 Set the list to the given size and set all entries to nullptr. More...
 
label squeezeNull ()
 Squeeze out nullptr entries in the list of pointers after which any null pointers will be at the end of the list. More...
 
void trimTrailingNull ()
 Reduce addressable list size to ignore any trailing null pointers. More...
 
void push_back (T *ptr)
 Append an element to the end of the list. More...
 
void push_back (UPtrList< T > &&other)
 Move append another list to the end of this list. More...
 
void swap (UPtrList< T > &list) noexcept
 Swap content. More...
 
void transfer (UPtrList< T > &list)
 Transfer contents into this list and annul the argument. More...
 
Tset (const label i, T *ptr)
 Set element to specified pointer and return the old list element, which can be a nullptr. More...
 
void reorder (const labelUList &oldToNew, const bool check=false)
 Reorder elements. Reordering must be unique (ie, shuffle). More...
 
void sortOrder (const labelUList &order, const bool check=false)
 Reorder elements according to new order mapping (newToOld). Reordering must be unique (ie, shuffle). More...
 
void checkNonNull () const
 Check and raise FatalError if any nullptr exists in the list. More...
 
const Tat (const label i) const
 Return const reference to the element at given position. FatalError for bounds problem or nullptr. More...
 
Tat (const label i)
 Return reference to the element at given position. FatalError for bounds problem or nullptr. More...
 
const Toperator[] (const label i) const
 Return const reference to the element at given position. FatalError for bounds problem or nullptr. Same as at(). More...
 
Toperator[] (const label i)
 Return reference to the element at given position. FatalError for bounds problem or nullptr. Same as at(). More...
 
 FOAM_DEPRECATED_FOR (2022-09, "get(), set() or test() methods") const T *operator()(const label i) const
 Deprecated(2022-09) - 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 ()
 Return iterator to begin traversal of non-nullptr entries. More...
 
iterator end () noexcept
 Return iterator beyond end of UPtrList traversal. More...
 
const_iterator cbegin () const
 Return const_iterator to begin traversal of non-nullptr entries. More...
 
const_iterator cend () const noexcept
 Return const_iterator beyond end of UPtrList traversal. More...
 
const_iterator begin () const
 Return const_iterator to begin traversal of non-nullptr entries. More...
 
const_iterator end () const noexcept
 Return const_iterator beyond end of UPtrList traversal. More...
 
void setSize (const label n)
 Alias for resize() More...
 
Tfirst ()
 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...
 
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...
 

Additional Inherited Members

- Public Types inherited from GeometricBoundaryField< Type, PatchField, GeoMesh >
typedef GeoMesh::BoundaryMesh BoundaryMesh
 The boundary mesh type for the boundary fields. More...
 
typedef DimensionedField< Type, GeoMeshInternal
 The internal field type associated with the boundary fields. More...
 
typedef PatchField< Type > Patch
 The patch field type for the boundary fields. More...
 
- Public Types inherited from FieldField< PatchField, Type >
typedef pTraits< Type >::cmptType cmptType
 Component type. More...
 
- 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...
 
- Static Public Member Functions inherited from FieldField< PatchField, Type >
static tmp< FieldField< PatchField, Type > > NewCalculatedType (const FieldField< PatchField, Type2 > &ff)
 Return a pointer to a new calculatedFvPatchFieldField created on. More...
 
- Static Public Attributes inherited from GeometricBoundaryField< Type, PatchField, GeoMesh >
static int debug
 Enable debug. More...
 
static scalar tolerance
 User-defined tolerance (for consistency checks) More...
 
static int localConsistency
 Enable local consistency. More...
 
- Protected Member Functions inherited from PtrList< PatchField< Type > >
void readIstream (Istream &is, const INew &inew)
 Read from Istream using Istream constructor class. More...
 
- Protected Member Functions inherited from UPtrList< T >
void setAddressableSize (const label n) noexcept
 Adjust addressable size. More...
 
label find_next (label pos) const
 The next non-null entry after the specified position. More...
 
 UPtrList (Detail::PtrListDetail< T > &&ptrs) noexcept
 Low-level move construct. More...
 
- Protected Attributes inherited from UPtrList< T >
Detail::PtrListDetail< Tptrs_
 The list of pointers. More...
 

Detailed Description

Distance calculation for cells with face on a wall. Searches pointNeighbours to find closest.

Source files

Definition at line 49 of file nearWallDist.H.

Constructor & Destructor Documentation

◆ nearWallDist()

nearWallDist ( const fvMesh mesh)

Construct from components.

Definition at line 84 of file nearWallDist.C.

◆ ~nearWallDist()

~nearWallDist ( )
virtual

Destructor.

Definition at line 100 of file nearWallDist.C.

Member Function Documentation

◆ y()

const volScalarField::Boundary& y ( ) const
inline

Definition at line 97 of file nearWallDist.H.

◆ correct()

void correct ( )
virtual

Correct for mesh geom/topo changes.

Definition at line 106 of file nearWallDist.C.

References fvPatchFieldBase::calculatedType(), forAll, fvPatchField< Type >::New(), setSize(), and UPtrList< T >::size().

Referenced by adjointRASModel::correct().

Here is the call graph for this function:
Here is the caller graph for this function:

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