faePatchField< Type > Class Template Reference

faePatchField<Type> abstract base class. This class gives a fat-interface to all derived classes covering all possible ways in which they might be used. The first level of derivation is to basic patchFields which cover zero-gradient, fixed-gradient, fixed-value and mixed conditions. The next level of derivation covers all the specialised typed with specific evaluation procedures, particularly with respect to specific fields. More...

Inheritance diagram for faePatchField< Type >:
[legend]
Collaboration diagram for faePatchField< Type >:
[legend]

Public Types

typedef DimensionedField< Type, edgeMeshInternal
 The internal field type associated with the patch field. More...
 
typedef faPatch Patch
 The patch type for the patch field. More...
 
typedef calculatedFaePatchField< Type > Calculated
 Type for a calculated patch. More...
 
- Public Types inherited from Field< Type >
typedef pTraits< Type >::cmptType cmptType
 Component type. More...
 
typedef SubField< Type > subField
 Declare type of subField. More...
 
- Public Types inherited from List< Type >
typedef SubList< Type > subList
 Declare type of subList. More...
 
- Public Types inherited from UList< T >
typedef T value_type
 The value type the list contains. More...
 
typedef Tpointer
 The pointer type for non-const access to value_type items. More...
 
typedef const Tconst_pointer
 The pointer type for const access to value_type items. More...
 
typedef Treference
 The type used for storing into value_type objects. More...
 
typedef const Tconst_reference
 The type used for reading from constant value_type objects. More...
 
typedef Titerator
 Random access iterator for traversing a UList. More...
 
typedef const Tconst_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< iteratorreverse_iterator
 Reverse iterator (non-const access) More...
 
typedef std::reverse_iterator< const_iteratorconst_reverse_iterator
 Reverse iterator (const access) More...
 

Public Member Functions

 TypeName ("faePatchField")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (tmp, faePatchField, patch,(const faPatch &p, const DimensionedField< Type, edgeMesh > &iF),(p, iF))
 
 declareRunTimeSelectionTable (tmp, faePatchField, patchMapper,(const faePatchField< Type > &ptf, const faPatch &p, const DimensionedField< Type, edgeMesh > &iF, const faPatchFieldMapper &m),(dynamic_cast< const faePatchFieldType & >(ptf), p, iF, m))
 
 declareRunTimeSelectionTable (tmp, faePatchField, dictionary,(const faPatch &p, const DimensionedField< Type, edgeMesh > &iF, const dictionary &dict),(p, iF, dict))
 
 faePatchField (const faPatch &, const DimensionedField< Type, edgeMesh > &)
 Construct from patch and internal field. More...
 
 faePatchField (const faPatch &, const DimensionedField< Type, edgeMesh > &, const Field< Type > &)
 Construct from patch and internal field and patch field. More...
 
 faePatchField (const faPatch &, const DimensionedField< Type, edgeMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 faePatchField (const faePatchField< Type > &, const faPatch &, const DimensionedField< Type, edgeMesh > &, const faPatchFieldMapper &)
 Construct by mapping the given faePatchField onto a new patch. More...
 
 faePatchField (const faePatchField< Type > &)
 Construct as copy. More...
 
virtual tmp< faePatchField< Type > > clone () const
 Construct and return a clone. More...
 
 faePatchField (const faePatchField< Type > &, const DimensionedField< Type, edgeMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< faePatchField< Type > > clone (const DimensionedField< Type, edgeMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual ~faePatchField ()=default
 Destructor. More...
 
const objectRegistrydb () const
 Return local objectRegistry. More...
 
const faPatchpatch () const
 Return patch. More...
 
const DimensionedField< Type, edgeMesh > & internalField () const
 Return dimensioned internal field reference. More...
 
const Field< Type > & primitiveField () const
 Return internal field reference. More...
 
virtual bool fixesValue () const
 Return true if this patch field fixes a value. More...
 
virtual bool coupled () const
 Return true if this patch field is coupled. More...
 
virtual void autoMap (const faPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const faePatchField< Type > &, const labelList &)
 Reverse map the given faePatchField onto this faePatchField. More...
 
virtual void write (Ostream &) const
 Write. More...
 
void check (const faePatchField< Type > &) const
 Check faePatchField<Type> against given faePatchField<Type> More...
 
virtual void operator= (const UList< Type > &)
 
virtual void operator= (const faePatchField< Type > &)
 
virtual void operator+= (const faePatchField< Type > &)
 
virtual void operator-= (const faePatchField< Type > &)
 
virtual void operator*= (const faePatchField< scalar > &)
 
virtual void operator/= (const faePatchField< scalar > &)
 
virtual void operator+= (const Field< Type > &)
 
virtual void operator-= (const Field< Type > &)
 
virtual void operator*= (const Field< scalar > &)
 
virtual void operator/= (const Field< scalar > &)
 
virtual void operator= (const Type &)
 
virtual void operator+= (const Type &)
 
virtual void operator-= (const Type &)
 
virtual void operator*= (const scalar)
 
virtual void operator/= (const scalar)
 
virtual void operator== (const faePatchField< Type > &)
 
virtual void operator== (const Field< Type > &)
 
virtual void operator== (const Type &)
 
template<class Type2 >
Foam::tmp< Foam::faePatchField< Type > > NewCalculatedType (const faePatchField< Type2 > &pf)
 
- Public Member Functions inherited from Field< Type >
constexpr Field () noexcept
 Default construct. More...
 
 Field (const label len)
 Construct given size. More...
 
 Field (const label len, const Type &val)
 Construct given size and initial value. More...
 
 Field (const label len, const Foam::zero)
 Construct given size and initial values of zero. More...
 
 Field (const Foam::one, const Type &val)
 Construct with length=1, copying the value as the only content. More...
 
 Field (const Foam::one, Type &&val)
 Construct with length=1, moving the value as the only content. More...
 
 Field (const Foam::one, const Foam::zero)
 Construct with length=1, initializing content to zero. More...
 
 Field (const Field< Type > &fld)
 Copy construct. More...
 
 Field (const UList< Type > &list)
 Copy construct from UList<Type> More...
 
template<class Addr >
 Field (const IndirectListBase< Type, Addr > &list)
 Copy construct from IndirectList. More...
 
 Field (Field< Type > &&fld)
 Move construct from Field. More...
 
 Field (List< Type > &&list)
 Move construct from List. More...
 
template<int SizeMin>
 Field (DynamicList< Type, SizeMin > &&list)
 Move construct from DynamicList. More...
 
 Field (const UList< Type > &mapF, const labelUList &mapAddressing)
 Construct by 1 to 1 mapping from the given field. More...
 
 Field (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
 Construct by 1 to 1 mapping from the given tmp field. More...
 
 Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given field. More...
 
 Field (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Construct by interpolative mapping from the given tmp field. More...
 
 Field (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
 Construct by mapping from the given field. More...
 
 Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
 Construct by mapping from the given field. More...
 
 Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
 Construct by mapping from the given field. More...
 
 Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
 Construct by mapping from the given tmp field. More...
 
 Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
 
 Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
 
 Field (Field< Type > &fld, bool reuse)
 Copy construct or re-use as specified. More...
 
 Field (const tmp< Field< Type > > &tfld)
 Copy or move construct from tmp. More...
 
 Field (Istream &is)
 Construct from Istream. More...
 
 Field (const word &keyword, const dictionary &dict, const label len)
 Construct from a dictionary entry. More...
 
tmp< Field< Type > > clone () const
 Clone. More...
 
void map (const UList< Type > &mapF, const labelUList &mapAddressing)
 1 to 1 map from the given field More...
 
void map (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
 1 to 1 map from the given tmp field More...
 
void map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given field. More...
 
void map (const tmp< Field< Type > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 Interpolative map from the given tmp field. More...
 
void map (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
 Map from the given field. More...
 
void map (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
 Map from the given tmp field. More...
 
void autoMap (const FieldMapper &map, const bool applyFlip=true)
 Map from self. More...
 
void rmap (const UList< Type > &mapF, const labelUList &mapAddressing)
 1 to 1 reverse-map from the given field More...
 
void rmap (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing)
 1 to 1 reverse-map from the given tmp field More...
 
void rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 Interpolative reverse map from the given field. More...
 
void rmap (const tmp< Field< Type > > &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 Interpolative reverse map from the given tmp field. More...
 
void negate ()
 Inplace negate this field (negative). More...
 
void normalise ()
 
tmp< Field< cmptType > > component (const direction) const
 Return a component field of the field. More...
 
void replace (const direction, const UList< cmptType > &)
 Replace a component field of the field. More...
 
void replace (const direction, const tmp< Field< cmptType > > &)
 Replace a component field of the field. More...
 
void replace (const direction, const cmptType &)
 Replace a component field of the field. More...
 
template<class VSForm >
VSForm block (const label start) const
 
tmp< Field< Type > > T () const
 Return the field transpose (only defined for second rank tensors) More...
 
void writeEntry (const word &keyword, Ostream &os) const
 Write the field as a dictionary entry. More...
 
SubField< Type > slice (const label pos, label len=-1)
 Return SubField slice (non-const access) - no range checking. More...
 
const SubField< Type > slice (const label pos, label len=-1) const
 Return SubField slice (const access) - no range checking. More...
 
SubField< Type > slice (const labelRange &range)
 Return SubField slice (non-const access) - with range checking. More...
 
const SubField< Type > slice (const labelRange &range) const
 Return SubField slice (const access) - with range checking. More...
 
void operator= (const Field< Type > &)
 Copy assignment. More...
 
void operator= (const tmp< Field< Type > > &)
 
void operator= (const UList< Type > &rhs)
 
void operator= (const SubField< Type > &rhs)
 
template<class Addr >
void operator= (const IndirectListBase< Type, Addr > &rhs)
 Copy assign from IndirectList. More...
 
void operator= (Field< Type > &&rhs)
 Move assignment. More...
 
void operator= (List< Type > &&rhs)
 
template<int SizeMin>
void operator= (DynamicList< Type, SizeMin > &&rhs)
 
void operator= (const Type &val)
 Value assignment. More...
 
void operator= (const Foam::zero)
 
template<class Form , class Cmpt , direction nCmpt>
void operator= (const VectorSpace< Form, Cmpt, nCmpt > &)
 
void operator+= (const UList< Type > &)
 
void operator+= (const tmp< Field< Type > > &)
 
void operator-= (const UList< Type > &)
 
void operator-= (const tmp< Field< Type > > &)
 
void operator*= (const UList< scalar > &)
 
void operator*= (const tmp< Field< scalar > > &)
 
void operator/= (const UList< scalar > &)
 
void operator/= (const tmp< Field< scalar > > &)
 
void operator+= (const Type &)
 
void operator-= (const Type &)
 
void operator*= (const scalar &)
 
void operator/= (const scalar &)
 
template<class Type >
void operator= (const tmp< Field > &rhs)
 
void normalise ()
 
void normalise ()
 
void normalise ()
 Inplace normalise (float) vector field. More...
 
void normalise ()
 Inplace normalise (double) vector field. More...
 
- Public Member Functions inherited from FieldBase
constexpr FieldBase () noexcept
 Default construct, refCount zero. More...
 
- Public Member Functions inherited from refCount
constexpr refCount () noexcept
 Default construct, initializing count to 0. More...
 
int 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 List< Type >
constexpr List () noexcept
 Default construct. More...
 
 List (const label len)
 Construct with given size. More...
 
 List (const label len, const Type &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 Type &val)
 Construct with length=1, copying the value as the only content. More...
 
 List (const Foam::one, Type &&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< Type > &a)
 Copy construct from list. More...
 
 List (const UList< Type > &a)
 Copy construct contents from list. More...
 
 List (List< Type > &a, bool reuse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< Type > &list, const labelUList &indices)
 Copy construct subset of list. More...
 
 List (const UList< Type > &list, const FixedList< label, N > &indices)
 Copy construct subset of list. More...
 
 List (const FixedList< Type, N > &list)
 Construct as copy of FixedList<T, N> More...
 
 List (const PtrList< Type > &list)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< Type > &list)
 Construct as copy of SLList<T> More...
 
 List (const IndirectListBase< Type, Addr > &list)
 Construct as copy of IndirectList contents. More...
 
 List (std::initializer_list< Type > list)
 Construct from an initializer list. More...
 
 List (List< Type > &&list)
 Move construct from List. More...
 
 List (DynamicList< Type, SizeMin > &&list)
 Move construct from DynamicList. More...
 
 List (SLList< Type > &&list)
 Move construct from SLList. More...
 
 List (Istream &is)
 Construct from Istream. More...
 
autoPtr< List< Type > > 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 Type &val)
 Adjust allocated size of list and set val for new elements. More...
 
void resize (const label newLen)
 
void resize_nocopy (const label len)
 Adjust allocated size of list without necessarily. More...
 
void setSize (const label n)
 Alias for resize() More...
 
void setSize (const label n, const Type &val)
 Alias for resize() More...
 
void append (const Type &val)
 Append an element at the end of the list. More...
 
void append (Type &&val)
 Move append an element at the end of the list. More...
 
void append (const UList< Type > &list)
 Append a List to the end of this list. More...
 
void append (const IndirectListBase< Type, Addr > &list)
 Append IndirectList contents at the end of this list. More...
 
label appendUniq (const Type &val)
 Append an element if not already in the list. More...
 
void transfer (List< Type > &list)
 
void transfer (DynamicList< Type, SizeMin > &list)
 
Type & newElmt (const label i)
 
void operator= (const UList< Type > &a)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const List< Type > &list)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< Type > &list)
 Assignment to SLList operator. Takes linear time. More...
 
void operator= (const IndirectListBase< Type, Addr > &list)
 Assignment from IndirectList. Takes linear time. More...
 
void operator= (const FixedList< Type, N > &list)
 Copy assignment from FixedList. More...
 
void operator= (std::initializer_list< Type > list)
 Assignment to an initializer list. More...
 
void operator= (const Type &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< Type > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (DynamicList< Type, SizeMin > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (SLList< Type > &&list)
 Move assignment. Takes constant time. More...
 
IstreamreadList (Istream &is)
 Read List from Istream, discarding contents of existing List. More...
 
IstreamreadList (Istream &is)
 
IstreamreadList (Istream &is)
 
void shallowCopy (const UList< Type > &)=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...
 
- Public Member Functions inherited from UList< T >
 UList (const UList< T > &)=default
 Copy construct. More...
 
constexpr UList () noexcept
 Default construct, zero-sized and nullptr. More...
 
 UList (T *__restrict__ v, const label len) noexcept
 Construct from components. More...
 
label fcIndex (const label i) const noexcept
 
label rcIndex (const label i) const noexcept
 
const TfcValue (const label i) const
 Return forward circular value (ie, next value in the list) More...
 
TfcValue (const label i)
 Return forward circular value (ie, next value in the list) More...
 
const TrcValue (const label i) const
 Return reverse circular value (ie, previous value in the list) More...
 
TrcValue (const label i)
 Return reverse circular value (ie, previous value in the list) More...
 
const Tcdata () const noexcept
 Return pointer to the underlying array serving as data storage. More...
 
Tdata () 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...
 
Tfirst ()
 Return the first element of the list. More...
 
const Tfirst () const
 Return first element of the list. More...
 
Tlast ()
 Return the last element of the list. More...
 
const Tlast () const
 Return the last element of the list. More...
 
std::streamsize size_bytes () const noexcept
 Number of contiguous bytes for the List data. More...
 
std::streamsize byteSize () const
 
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...
 
label find (const T &val, label pos=0) const
 Find index of the first occurrence of the value. More...
 
label rfind (const T &val, label pos=-1) const
 Find index of the last occurrence of the value. More...
 
bool found (const T &val, label pos=0) const
 True if the value if found in the list. 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 (const UList< T > &list)
 Copy the pointer and size held by the given UList. More...
 
void deepCopy (const UList< T > &list)
 Copy elements of the given UList. Sizes must match! More...
 
template<class Addr >
void deepCopy (const IndirectListBase< T, Addr > &list)
 Copy elements of the given indirect list. Sizes must match! More...
 
SubList< Tslice (const label pos, label len=-1)
 Return SubList slice (non-const access) - no range checking. More...
 
const SubList< Tslice (const label pos, label len=-1) const
 Return SubList slice (const access) - no range checking. More...
 
SubList< Tslice (const labelRange &range)
 Return SubList slice (non-const access) - with range checking. More...
 
const SubList< Tslice (const labelRange &range) const
 Return SubList slice (const access) - with range checking. More...
 
Toperator[] (const label i)
 Return element of UList. More...
 
const Toperator[] (const label i) const
 Return element of constant UList. More...
 
 operator const Foam::List< T > & () const
 Allow cast to a const List<T>&. More...
 
void operator= (const T &val)
 Assignment of all entries to the given value. More...
 
void operator= (const Foam::zero)
 Assignment of all entries to zero. More...
 
iterator begin () noexcept
 Return an iterator to begin traversing the UList. More...
 
iterator end () noexcept
 Return an iterator to end traversing the UList. More...
 
const_iterator cbegin () const noexcept
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator cend () const noexcept
 Return const_iterator to end traversing the constant UList. More...
 
const_iterator begin () const noexcept
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator end () 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...
 
reverse_iterator rend ()
 Return 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...
 
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
label size () const noexcept
 The number of elements in the UList. More...
 
bool empty () const noexcept
 True if the UList is empty (ie, size() is zero) More...
 
void swap (UList< T > &list)
 Swap content with another UList of the same type in constant time. More...
 
bool operator== (const UList< T > &a) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< T > &a) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< T > &list) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< T > &a) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< T > &a) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< T > &a) const
 Return true if !(a < b). Takes linear time. More...
 
IstreamreadList (Istream &is)
 Read List contents from Istream. More...
 
void writeEntry (const word &keyword, Ostream &os) const
 Write the List as a dictionary entry with keyword. More...
 
OstreamwriteList (Ostream &os, const label shortLen=0) const
 Write List, with line-breaks in ASCII when length exceeds shortLen. More...
 
template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type test (const label i) const
 
template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type get (const label i) const
 
template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type unset (const label i)
 
IstreamreadList (Istream &is)
 
OstreamwriteList (Ostream &os, const label) const
 
const booloperator[] (const label i) const
 
Foam::UPstream::commsStructoperator[] (const label procID)
 
const Foam::UPstream::commsStructoperator[] (const label procID) const
 
UPstream::commsStructoperator[] (const label procID)
 
const UPstream::commsStructoperator[] (const label procID) const
 
OstreamwriteList (Ostream &os, const label) const
 
IstreamreadList (Istream &is)
 

Static Public Member Functions

static tmp< faePatchField< Type > > New (const word &patchFieldType, const faPatch &, const DimensionedField< Type, edgeMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
static tmp< faePatchField< Type > > New (const word &patchFieldType, const word &actualPatchType, const faPatch &, const DimensionedField< Type, edgeMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
static tmp< faePatchField< Type > > New (const faePatchField< Type > &, const faPatch &, const DimensionedField< Type, edgeMesh > &, const faPatchFieldMapper &)
 Return a pointer to a new patchField created on freestore from. More...
 
static tmp< faePatchField< Type > > New (const faPatch &, const DimensionedField< Type, edgeMesh > &, const dictionary &)
 Return a pointer to a new patchField created on freestore. More...
 
template<class Type2 >
static tmp< faePatchField< Type > > NewCalculatedType (const faePatchField< Type2 > &)
 Return a pointer to a new calculatedFaePatchField created on. More...
 
static const wordcalculatedType ()
 Return the type of the calculated for of faePatchField. More...
 
- Static Public Member Functions inherited from Field< Type >
static const Field< Type > & null ()
 Return nullObject reference Field. More...
 
static autoPtr< Field< Type > > New (Istream &is)
 Return a pointer to a new Field created on freestore. More...
 
template<class Type2 >
static tmp< Field< Type > > NewCalculatedType (const Field< Type2 > &f)
 
- Static Public Member Functions inherited from List< Type >
static const List< Type > & null ()
 Return a null List. More...
 
- Static Public Member Functions inherited from UList< T >
static const UList< T > & null ()
 Return a UList reference to a nullObject. More...
 
static constexpr label max_size () noexcept
 The size of the largest possible UList. More...
 

Static Public Attributes

static int disallowGenericFaePatchField
 Debug switch to disallow the use of. More...
 
- Static Public Attributes inherited from FieldBase
static const char *const typeName
 Typename for Field. More...
 
static bool allowConstructFromLargerSize = false
 Permit read construct from a larger size. More...
 

Friends

Ostreamoperator (Ostream &, const faePatchField< Type > &)
 

Additional Inherited Members

- Protected Member Functions inherited from UList< T >
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...
 
labelRange validateRange (const labelRange &requestedRange) const
 
UList< T > & operator= (const UList< T > &)=delete
 No copy assignment (default: shallow copy) More...
 
void writeEntry (Ostream &os) const
 
void writeEntry (Ostream &os) const
 

Detailed Description

template<class Type>
class Foam::faePatchField< Type >

faePatchField<Type> abstract base class. This class gives a fat-interface to all derived classes covering all possible ways in which they might be used. The first level of derivation is to basic patchFields which cover zero-gradient, fixed-gradient, fixed-value and mixed conditions. The next level of derivation covers all the specialised typed with specific evaluation procedures, particularly with respect to specific fields.

Finite area edge-based patch fields.

Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.

Source files

Definition at line 80 of file faePatchField.H.

Member Typedef Documentation

◆ Internal

The internal field type associated with the patch field.

Definition at line 96 of file faePatchField.H.

◆ Patch

typedef faPatch Patch

The patch type for the patch field.

Definition at line 99 of file faePatchField.H.

◆ Calculated

Type for a calculated patch.

Definition at line 102 of file faePatchField.H.

Constructor & Destructor Documentation

◆ faePatchField() [1/6]

faePatchField ( const faPatch p,
const DimensionedField< Type, edgeMesh > &  iF 
)

Construct from patch and internal field.

Definition at line 34 of file faePatchField.C.

◆ faePatchField() [2/6]

faePatchField ( const faPatch p,
const DimensionedField< Type, edgeMesh > &  iF,
const Field< Type > &  f 
)

Construct from patch and internal field and patch field.

Definition at line 47 of file faePatchField.C.

◆ faePatchField() [3/6]

faePatchField ( const faPatch p,
const DimensionedField< Type, edgeMesh > &  iF,
const dictionary dict 
)

Construct from patch, internal field and dictionary.

Definition at line 76 of file faePatchField.C.

References dict, dictionary::found(), faePatchField< Type >::operator=(), p, and UList< T >::size().

Here is the call graph for this function:

◆ faePatchField() [4/6]

faePatchField ( const faePatchField< Type > &  ptf,
const faPatch p,
const DimensionedField< Type, edgeMesh > &  iF,
const faPatchFieldMapper mapper 
)

Construct by mapping the given faePatchField onto a new patch.

Definition at line 61 of file faePatchField.C.

◆ faePatchField() [5/6]

faePatchField ( const faePatchField< Type > &  ptf)

Construct as copy.

Definition at line 102 of file faePatchField.C.

◆ faePatchField() [6/6]

faePatchField ( const faePatchField< Type > &  ptf,
const DimensionedField< Type, edgeMesh > &  iF 
)

Construct as copy setting internal field reference.

Definition at line 114 of file faePatchField.C.

◆ ~faePatchField()

virtual ~faePatchField ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "faePatchField< Type >"  )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/3]

declareRunTimeSelectionTable ( tmp  ,
faePatchField< Type >  ,
patch  ,
(const faPatch &p, const DimensionedField< Type, edgeMesh > &iF)  ,
(p, iF)   
)

◆ declareRunTimeSelectionTable() [2/3]

declareRunTimeSelectionTable ( tmp  ,
faePatchField< Type >  ,
patchMapper  ,
(const faePatchField< Type > &ptf, const faPatch &p, const DimensionedField< Type, edgeMesh > &iF, const faPatchFieldMapper &m)  ,
(dynamic_cast< const faePatchFieldType & >(ptf), p, iF, m)   
)

◆ declareRunTimeSelectionTable() [3/3]

declareRunTimeSelectionTable ( tmp  ,
faePatchField< Type >  ,
dictionary  ,
(const faPatch &p, const DimensionedField< Type, edgeMesh > &iF, const dictionary &dict ,
(p, iF, dict  
)

◆ clone() [1/2]

◆ clone() [2/2]

virtual tmp< faePatchField< Type > > clone ( const DimensionedField< Type, edgeMesh > &  iF) const
inlinevirtual

◆ New() [1/4]

Foam::tmp< Foam::faePatchField< Type > > New ( const word patchFieldType,
const faPatch p,
const DimensionedField< Type, edgeMesh > &  iF 
)
static

Return a pointer to a new patchField created on freestore given.

patch and internal field (does not set the patch field values)

Definition at line 72 of file faePatchFieldNew.C.

References Foam::New(), and p.

Here is the call graph for this function:

◆ New() [2/4]

Foam::tmp< Foam::faePatchField< Type > > New ( const word patchFieldType,
const word actualPatchType,
const faPatch p,
const DimensionedField< Type, edgeMesh > &  iF 
)
static

Return a pointer to a new patchField created on freestore given.

patch and internal field (does not set the patch field values) Allows override of constraint type

Definition at line 32 of file faePatchFieldNew.C.

References DebugInFunction, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInLookup, and p.

Here is the call graph for this function:

◆ New() [3/4]

Foam::tmp< Foam::faePatchField< Type > > New ( const faePatchField< Type > &  ptf,
const faPatch p,
const DimensionedField< Type, edgeMesh > &  iF,
const faPatchFieldMapper pfMapper 
)
static

Return a pointer to a new patchField created on freestore from.

a given faePatchField mapped onto a new patch

Definition at line 141 of file faePatchFieldNew.C.

References DebugInFunction, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInLookup, and p.

Here is the call graph for this function:

◆ New() [4/4]

Foam::tmp< Foam::faePatchField< Type > > New ( const faPatch p,
const DimensionedField< Type, edgeMesh > &  iF,
const dictionary dict 
)
static

Return a pointer to a new patchField created on freestore.

from dictionary

Definition at line 84 of file faePatchFieldNew.C.

References DebugInFunction, dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::nl, and p.

Here is the call graph for this function:

◆ NewCalculatedType() [1/2]

static tmp< faePatchField< Type > > NewCalculatedType ( const faePatchField< Type2 > &  )
static

Return a pointer to a new calculatedFaePatchField created on.

freestore without setting patchField values

◆ db()

Return local objectRegistry.

Definition at line 129 of file faePatchField.C.

References IOobject::db().

Here is the call graph for this function:

◆ patch()

const faPatch & patch ( ) const
inline

Return patch.

Definition at line 281 of file faePatchField.H.

Referenced by cyclicFaePatchField< Type >::cyclicFaePatchField(), emptyFaePatchField< Type >::emptyFaePatchField(), faePatchField< Type >::NewCalculatedType(), processorFaePatchField< Type >::processorFaePatchField(), symmetryFaePatchField< Type >::symmetryFaePatchField(), and wedgeFaePatchField< Type >::wedgeFaePatchField().

Here is the caller graph for this function:

◆ internalField()

const DimensionedField< Type, edgeMesh > & internalField ( ) const
inline

Return dimensioned internal field reference.

Definition at line 287 of file faePatchField.H.

◆ primitiveField()

const Field< Type > & primitiveField ( ) const
inline

Return internal field reference.

Definition at line 293 of file faePatchField.H.

◆ calculatedType()

const Foam::word & calculatedType
static

Return the type of the calculated for of faePatchField.

Definition at line 35 of file calculatedFaePatchField.C.

◆ fixesValue()

virtual bool fixesValue ( ) const
inlinevirtual

Return true if this patch field fixes a value.

Needed to check if a level has to be specified while solving Poissons equations.

Reimplemented in calculatedFaePatchField< Type >, and fixedValueFaePatchField< Type >.

Definition at line 304 of file faePatchField.H.

◆ coupled()

virtual bool coupled ( ) const
inlinevirtual

Return true if this patch field is coupled.

Reimplemented in coupledFaePatchField< Type >, and processorFaePatchField< Type >.

Definition at line 310 of file faePatchField.H.

◆ autoMap()

void autoMap ( const faPatchFieldMapper m)
virtual

Map (and resize as needed) from self given a mapping object.

Reimplemented in emptyFaePatchField< Type >.

Definition at line 149 of file faePatchField.C.

References Field< Type >::autoMap().

Here is the call graph for this function:

◆ rmap()

void rmap ( const faePatchField< Type > &  ptf,
const labelList addr 
)
virtual

Reverse map the given faePatchField onto this faePatchField.

Reimplemented in emptyFaePatchField< Type >.

Definition at line 159 of file faePatchField.C.

◆ write()

void write ( Ostream os) const
virtual

◆ check()

void check ( const faePatchField< Type > &  ptf) const

Check faePatchField<Type> against given faePatchField<Type>

Definition at line 137 of file faePatchField.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ operator=() [1/3]

void operator= ( const UList< Type > &  ul)
virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 184 of file faePatchField.C.

Referenced by faePatchField< Type >::faePatchField().

Here is the caller graph for this function:

◆ operator=() [2/3]

void operator= ( const faePatchField< Type > &  ptf)
virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 194 of file faePatchField.C.

◆ operator+=() [1/3]

void operator+= ( const faePatchField< Type > &  ptf)
virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 205 of file faePatchField.C.

References Foam::check(), and Field< Type >::operator+=().

Here is the call graph for this function:

◆ operator-=() [1/3]

void operator-= ( const faePatchField< Type > &  ptf)
virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 216 of file faePatchField.C.

References Foam::check(), and Field< Type >::operator-=().

Here is the call graph for this function:

◆ operator*=() [1/3]

void operator*= ( const faePatchField< scalar > &  ptf)
virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 227 of file faePatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and Field< Type >::operator*=().

Here is the call graph for this function:

◆ operator/=() [1/3]

void operator/= ( const faePatchField< scalar > &  ptf)
virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 244 of file faePatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and Field< Type >::operator/=().

Here is the call graph for this function:

◆ operator+=() [2/3]

void operator+= ( const Field< Type > &  tf)
virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 261 of file faePatchField.C.

References Field< Type >::operator+=().

Here is the call graph for this function:

◆ operator-=() [2/3]

void operator-= ( const Field< Type > &  tf)
virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 271 of file faePatchField.C.

References Field< Type >::operator-=().

Here is the call graph for this function:

◆ operator*=() [2/3]

void operator*= ( const Field< scalar > &  tf)
virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 281 of file faePatchField.C.

References Field< Type >::operator*=().

Here is the call graph for this function:

◆ operator/=() [2/3]

void operator/= ( const Field< scalar > &  tf)
virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 291 of file faePatchField.C.

References Field< Type >::operator/=().

Here is the call graph for this function:

◆ operator=() [3/3]

void operator= ( const Type &  t)
virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 301 of file faePatchField.C.

References Field< Type >::operator=().

Here is the call graph for this function:

◆ operator+=() [3/3]

void operator+= ( const Type &  t)
virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 311 of file faePatchField.C.

References Field< Type >::operator+=().

Here is the call graph for this function:

◆ operator-=() [3/3]

void operator-= ( const Type &  t)
virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 321 of file faePatchField.C.

◆ operator*=() [3/3]

void operator*= ( const scalar  s)
virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 331 of file faePatchField.C.

◆ operator/=() [3/3]

void operator/= ( const scalar  s)
virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 341 of file faePatchField.C.

◆ operator==() [1/3]

void operator== ( const faePatchField< Type > &  ptf)
virtual

Definition at line 351 of file faePatchField.C.

◆ operator==() [2/3]

void operator== ( const Field< Type > &  tf)
virtual

Definition at line 361 of file faePatchField.C.

◆ operator==() [3/3]

void operator== ( const Type &  t)
virtual

Definition at line 371 of file faePatchField.C.

References Field< Type >::operator=().

Here is the call graph for this function:

◆ NewCalculatedType() [2/2]

Foam::tmp< Foam::faePatchField< Type > > NewCalculatedType ( const faePatchField< Type2 > &  pf)

Definition at line 102 of file calculatedFaePatchField.C.

References faePatchField< Type >::patch().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator

Ostream & operator ( Ostream ,
const faePatchField< Type > &   
)
friend

Member Data Documentation

◆ disallowGenericFaePatchField

int disallowGenericFaePatchField
static

Debug switch to disallow the use of.

Definition at line 109 of file faePatchField.H.


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