faPatchField<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...
Public Types | |
typedef DimensionedField< Type, areaMesh > | Internal |
The internal field type associated with the patch field. More... | |
typedef faPatch | Patch |
The patch type for the patch field. More... | |
typedef calculatedFaPatchField< 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 T * | pointer |
The pointer type for non-const access to value_type items. More... | |
typedef const T * | const_pointer |
The pointer type for const access to value_type items. More... | |
typedef T & | reference |
The type used for storing into value_type objects. More... | |
typedef const T & | const_reference |
The type used for reading from constant value_type objects. More... | |
typedef T * | iterator |
Random access iterator for traversing a UList. More... | |
typedef const T * | 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... | |
Public Member Functions | |
TypeName ("faPatchField") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (tmp, faPatchField, patch,(const faPatch &p, const DimensionedField< Type, areaMesh > &iF),(p, iF)) | |
declareRunTimeSelectionTable (tmp, faPatchField, patchMapper,(const faPatchField< Type > &ptf, const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const faPatchFieldMapper &m),(dynamic_cast< const faPatchFieldType & >(ptf), p, iF, m)) | |
declareRunTimeSelectionTable (tmp, faPatchField, dictionary,(const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const dictionary &dict),(p, iF, dict)) | |
faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &) | |
Construct from patch and internal field. More... | |
faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const Field< Type > &) | |
Construct from patch and internal field and patch field. More... | |
faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &, const bool valueRequired=true) | |
Construct from patch, internal field and dictionary. More... | |
faPatchField (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &) | |
Construct by mapping the given faPatchField onto a new patch. More... | |
faPatchField (const faPatchField< Type > &) | |
Construct as copy. More... | |
virtual tmp< faPatchField< Type > > | clone () const |
Construct and return a clone. More... | |
faPatchField (const faPatchField< Type > &, const DimensionedField< Type, areaMesh > &) | |
Construct as copy setting internal field reference. More... | |
virtual tmp< faPatchField< Type > > | clone (const DimensionedField< Type, areaMesh > &iF) const |
Construct and return a clone setting internal field reference. More... | |
virtual | ~faPatchField ()=default |
Destructor. More... | |
const objectRegistry & | db () const |
Return local objectRegistry. More... | |
const faPatch & | patch () const |
Return patch. More... | |
const DimensionedField< Type, areaMesh > & | internalField () const |
Return dimensioned internal field reference. More... | |
const Field< Type > & | primitiveField () const |
Return internal field reference. More... | |
const word & | patchType () const |
Optional patch type. More... | |
word & | patchType () |
Optional patch type. 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... | |
bool | updated () const |
Return true if the boundary condition has already been updated. More... | |
virtual void | autoMap (const faPatchFieldMapper &) |
Map (and resize as needed) from self given a mapping object. More... | |
virtual void | rmap (const faPatchField< Type > &, const labelList &) |
Reverse map the given faPatchField onto this faPatchField. More... | |
virtual tmp< Field< Type > > | snGrad () const |
Return patch-normal gradient. More... | |
virtual void | updateCoeffs () |
Update the coefficients associated with the patch field. More... | |
virtual tmp< Field< Type > > | patchInternalField () const |
Return internal field next to patch as patch field. More... | |
virtual tmp< Field< Type > > | patchNeighbourField () const |
Return patchField on the opposite patch of a coupled patch. More... | |
virtual void | initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking) |
Initialise the evaluation of the patch field. More... | |
virtual void | evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking) |
Evaluate the patch field, sets Updated to false. More... | |
virtual tmp< Field< Type > > | valueInternalCoeffs (const tmp< Field< scalar > > &) const |
virtual tmp< Field< Type > > | valueBoundaryCoeffs (const tmp< Field< scalar > > &) const |
virtual tmp< Field< Type > > | gradientInternalCoeffs () const |
virtual tmp< Field< Type > > | gradientBoundaryCoeffs () const |
virtual void | write (Ostream &) const |
Write. More... | |
void | check (const faPatchField< Type > &) const |
Check faPatchField<Type> against given faPatchField<Type> More... | |
virtual void | operator= (const UList< Type > &) |
virtual void | operator= (const faPatchField< Type > &) |
virtual void | operator+= (const faPatchField< Type > &) |
virtual void | operator-= (const faPatchField< Type > &) |
virtual void | operator*= (const faPatchField< scalar > &) |
virtual void | operator/= (const faPatchField< 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 faPatchField< Type > &) |
virtual void | operator== (const Field< Type > &) |
virtual void | operator== (const Type &) |
template<class Type2 > | |
Foam::tmp< Foam::faPatchField< Type > > | NewCalculatedType (const faPatchField< 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... | |
Istream & | readList (Istream &is) |
Read List from Istream, discarding contents of existing List. More... | |
Istream & | readList (Istream &is) |
Istream & | readList (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 T & | fcValue (const label i) const |
Return forward circular value (ie, next value in the list) More... | |
T & | fcValue (const label i) |
Return forward circular value (ie, next value in the list) More... | |
const T & | rcValue (const label i) const |
Return reverse circular value (ie, previous value in the list) More... | |
T & | rcValue (const label i) |
Return reverse circular value (ie, previous value in the list) More... | |
const T * | cdata () const noexcept |
Return pointer to the underlying array serving as data storage. More... | |
T * | 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... | |
T & | first () |
Return the first element of the list. More... | |
const T & | first () const |
Return first element of the list. More... | |
T & | last () |
Return the last element of the list. More... | |
const T & | last () 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< T > | slice (const label pos, label len=-1) |
Return SubList slice (non-const access) - no range checking. More... | |
const SubList< T > | slice (const label pos, label len=-1) const |
Return SubList slice (const access) - no range checking. More... | |
SubList< T > | slice (const labelRange &range) |
Return SubList slice (non-const access) - with range checking. More... | |
const SubList< T > | slice (const labelRange &range) const |
Return SubList slice (const access) - with range checking. More... | |
T & | operator[] (const label i) |
Return element of UList. More... | |
const T & | operator[] (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... | |
Istream & | readList (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... | |
Ostream & | writeList (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) |
Istream & | readList (Istream &is) |
Ostream & | writeList (Ostream &os, const label) const |
const bool & | operator[] (const label i) const |
Foam::UPstream::commsStruct & | operator[] (const label procID) |
const Foam::UPstream::commsStruct & | operator[] (const label procID) const |
UPstream::commsStruct & | operator[] (const label procID) |
const UPstream::commsStruct & | operator[] (const label procID) const |
Ostream & | writeList (Ostream &os, const label) const |
Istream & | readList (Istream &is) |
Static Public Member Functions | |
static tmp< faPatchField< Type > > | New (const word &patchFieldType, const word &actualPatchType, const faPatch &, const DimensionedField< Type, areaMesh > &) |
static tmp< faPatchField< Type > > | New (const word &patchFieldType, const faPatch &, const DimensionedField< Type, areaMesh > &) |
static tmp< faPatchField< Type > > | New (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &) |
static tmp< faPatchField< Type > > | New (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &) |
template<class Type2 > | |
static tmp< faPatchField< Type > > | NewCalculatedType (const faPatchField< Type2 > &) |
static const word & | calculatedType () |
Return the type of the calculated for of faPatchField. 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 | disallowGenericFaPatchField |
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 | |
Ostream & | operator (Ostream &, const faPatchField< 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 |
faPatchField<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.
Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.
Definition at line 79 of file faPatchField.H.
typedef DimensionedField<Type, areaMesh> Internal |
The internal field type associated with the patch field.
Definition at line 104 of file faPatchField.H.
The patch type for the patch field.
Definition at line 107 of file faPatchField.H.
typedef calculatedFaPatchField<Type> Calculated |
Type for a calculated patch.
Definition at line 110 of file faPatchField.H.
faPatchField | ( | const faPatch & | p, |
const DimensionedField< Type, areaMesh > & | iF | ||
) |
Construct from patch and internal field.
Definition at line 35 of file faPatchField.C.
faPatchField | ( | const faPatch & | p, |
const DimensionedField< Type, areaMesh > & | iF, | ||
const Field< Type > & | f | ||
) |
Construct from patch and internal field and patch field.
Definition at line 50 of file faPatchField.C.
faPatchField | ( | const faPatch & | p, |
const DimensionedField< Type, areaMesh > & | iF, | ||
const dictionary & | dict, | ||
const bool | valueRequired = true |
||
) |
Construct from patch, internal field and dictionary.
if (valueRequired) - not yet needed. Already a lazy evaluation
Definition at line 83 of file faPatchField.C.
References dict, dictionary::found(), keyType::LITERAL, faPatchField< Type >::operator=(), p, dictionary::readIfPresent(), and UList< T >::size().
faPatchField | ( | const faPatchField< Type > & | ptf, |
const faPatch & | p, | ||
const DimensionedField< Type, areaMesh > & | iF, | ||
const faPatchFieldMapper & | mapper | ||
) |
Construct by mapping the given faPatchField onto a new patch.
Definition at line 66 of file faPatchField.C.
faPatchField | ( | const faPatchField< Type > & | ptf | ) |
Construct as copy.
Definition at line 116 of file faPatchField.C.
faPatchField | ( | const faPatchField< Type > & | ptf, |
const DimensionedField< Type, areaMesh > & | iF | ||
) |
Construct as copy setting internal field reference.
Definition at line 130 of file faPatchField.C.
|
virtualdefault |
Destructor.
TypeName | ( | "faPatchField< Type >" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | tmp | , |
faPatchField< Type > | , | ||
patch | , | ||
(const faPatch &p, const DimensionedField< Type, areaMesh > &iF) | , | ||
(p, iF) | |||
) |
declareRunTimeSelectionTable | ( | tmp | , |
faPatchField< Type > | , | ||
patchMapper | , | ||
(const faPatchField< Type > &ptf, const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const faPatchFieldMapper &m) | , | ||
(dynamic_cast< const faPatchFieldType & >(ptf), p, iF, m) | |||
) |
declareRunTimeSelectionTable | ( | tmp | , |
faPatchField< Type > | , | ||
dictionary | , | ||
(const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const dictionary &dict) | , | ||
(p, iF, dict) | |||
) |
|
inlinevirtual |
Construct and return a clone.
Reimplemented in basicSymmetryFaPatchField< Type >, calculatedFaPatchField< Type >, fixedGradientFaPatchField< Type >, fixedValueFaPatchField< Type >, mixedFaPatchField< Type >, zeroGradientFaPatchField< Type >, cyclicFaPatchField< Type >, emptyFaPatchField< Type >, processorFaPatchField< Type >, symmetryFaPatchField< Type >, wedgeFaPatchField< Type >, clampedPlateFaPatchField< Type >, fixedValueOutflowFaPatchField< Type >, inletOutletFaPatchField< Type >, slipFaPatchField< Type >, timeVaryingUniformFixedValueFaPatchField< Type >, genericFaPatchField< Type >, coupledFaPatchField< Type >, and transformFaPatchField< Type >.
Definition at line 201 of file faPatchField.H.
|
inlinevirtual |
Construct and return a clone setting internal field reference.
Reimplemented in coupledFaPatchField< Type >, transformFaPatchField< Type >, basicSymmetryFaPatchField< Type >, calculatedFaPatchField< Type >, fixedGradientFaPatchField< Type >, fixedValueFaPatchField< Type >, mixedFaPatchField< Type >, zeroGradientFaPatchField< Type >, cyclicFaPatchField< Type >, emptyFaPatchField< Type >, processorFaPatchField< Type >, symmetryFaPatchField< Type >, wedgeFaPatchField< Type >, clampedPlateFaPatchField< Type >, fixedValueOutflowFaPatchField< Type >, inletOutletFaPatchField< Type >, slipFaPatchField< Type >, timeVaryingUniformFixedValueFaPatchField< Type >, and genericFaPatchField< Type >.
Definition at line 214 of file faPatchField.H.
|
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 32 of file faPatchFieldNew.C.
References DebugInFunction, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInLookup, p, and tmp< T >::ref().
|
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 84 of file faPatchFieldNew.C.
References Foam::New(), and p.
|
static |
Return a pointer to a new patchField created on freestore from a given faPatchField mapped onto a new patch
Definition at line 152 of file faPatchFieldNew.C.
References DebugInFunction, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInLookup, and p.
|
static |
Return a pointer to a new patchField created on freestore from dictionary
Definition at line 96 of file faPatchFieldNew.C.
References DebugInFunction, dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::nl, and p.
|
static |
Return a pointer to a new calculatedFaPatchField created on freestore without setting patchField values
const Foam::objectRegistry & db |
Return local objectRegistry.
Definition at line 147 of file faPatchField.C.
References IOobject::db().
|
inline |
Return patch.
Definition at line 286 of file faPatchField.H.
Referenced by cyclicFaPatchField< Type >::cyclicFaPatchField(), genericFaPatchField< Type >::genericFaPatchField(), faPatchField< Type >::NewCalculatedType(), processorFaPatchField< Type >::processorFaPatchField(), symmetryFaPatchField< Type >::symmetryFaPatchField(), and wedgeFaPatchField< Type >::wedgeFaPatchField().
|
inline |
Return dimensioned internal field reference.
Definition at line 292 of file faPatchField.H.
Referenced by cyclicFaPatchField< Type >::cyclicFaPatchField(), emptyFaPatchField< Type >::emptyFaPatchField(), genericFaPatchField< Type >::genericFaPatchField(), processorFaPatchField< Type >::processorFaPatchField(), and symmetryFaPatchField< Type >::symmetryFaPatchField().
|
inline |
Return internal field reference.
Definition at line 298 of file faPatchField.H.
|
inline |
Optional patch type.
Definition at line 304 of file faPatchField.H.
|
inline |
Optional patch type.
Definition at line 310 of file faPatchField.H.
|
static |
Return the type of the calculated for of faPatchField.
Definition at line 35 of file calculatedFaPatchField.C.
|
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 calculatedFaPatchField< Type >, fixedValueFaPatchField< Type >, mixedFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 321 of file faPatchField.H.
|
inlinevirtual |
Return true if this patch field is coupled.
Reimplemented in coupledFaPatchField< Type >, and processorFaPatchField< Type >.
Definition at line 327 of file faPatchField.H.
Referenced by faMatrix< Type >::addBoundarySource(), and faMatrix< Type >::relax().
|
inline |
Return true if the boundary condition has already been updated.
Definition at line 333 of file faPatchField.H.
|
virtual |
Map (and resize as needed) from self given a mapping object.
Reimplemented in fixedGradientFaPatchField< Type >, mixedFaPatchField< Type >, emptyFaPatchField< Type >, and genericFaPatchField< Type >.
Definition at line 182 of file faPatchField.C.
References Field< Type >::autoMap().
|
virtual |
Reverse map the given faPatchField onto this faPatchField.
Reimplemented in fixedGradientFaPatchField< Type >, mixedFaPatchField< Type >, emptyFaPatchField< Type >, and genericFaPatchField< Type >.
Definition at line 189 of file faPatchField.C.
Referenced by fixedGradientFaPatchField< Type >::rmap(), and mixedFaPatchField< Type >::rmap().
|
virtual |
Return patch-normal gradient.
Reimplemented in basicSymmetryFaPatchField< Type >, basicSymmetryFaPatchField< Type >, basicSymmetryFaPatchField< Type >, coupledFaPatchField< Type >, fixedGradientFaPatchField< Type >, mixedFaPatchField< Type >, zeroGradientFaPatchField< Type >, processorFaPatchField< Type >, wedgeFaPatchField< Type >, wedgeFaPatchField< Type >, wedgeFaPatchField< Type >, clampedPlateFaPatchField< Type >, and transformFaPatchField< Type >.
Definition at line 167 of file faPatchField.C.
|
inlinevirtual |
Update the coefficients associated with the patch field.
Sets Updated to true
Reimplemented in emptyFaPatchField< Type >, inletOutletFaPatchField< Type >, and timeVaryingUniformFixedValueFaPatchField< Type >.
Definition at line 362 of file faPatchField.H.
|
virtual |
Return internal field next to patch as patch field.
Definition at line 175 of file faPatchField.C.
Referenced by clampedPlateFaPatchField< Type >::clampedPlateFaPatchField(), and zeroGradientFaPatchField< Type >::zeroGradientFaPatchField().
Return patchField on the opposite patch of a coupled patch.
Reimplemented in cyclicFaPatchField< Type >, processorFaPatchField< Type >, and coupledFaPatchField< Type >.
Definition at line 371 of file faPatchField.H.
References NotImplemented.
Referenced by faMatrix< Type >::addBoundarySource().
|
inlinevirtual |
Initialise the evaluation of the patch field.
Reimplemented in coupledFaPatchField< Type >, and processorFaPatchField< Type >.
Definition at line 378 of file faPatchField.H.
|
virtual |
Evaluate the patch field, sets Updated to false.
Reimplemented in basicSymmetryFaPatchField< Type >, coupledFaPatchField< Type >, processorFaPatchField< Type >, wedgeFaPatchField< Type >, basicSymmetryFaPatchField< Type >, fixedGradientFaPatchField< Type >, mixedFaPatchField< Type >, zeroGradientFaPatchField< Type >, wedgeFaPatchField< Type >, clampedPlateFaPatchField< Type >, basicSymmetryFaPatchField< Type >, wedgeFaPatchField< Type >, and clampedPlateFaPatchField< Type >.
Definition at line 200 of file faPatchField.C.
|
inlinevirtual |
Return the matrix diagonal coefficients corresponding to the evaluation of the value of this patchField with given weights
Reimplemented in calculatedFaPatchField< Type >, coupledFaPatchField< Type >, fixedGradientFaPatchField< Type >, fixedValueFaPatchField< Type >, mixedFaPatchField< Type >, transformFaPatchField< Type >, zeroGradientFaPatchField< Type >, emptyFaPatchField< Type >, clampedPlateFaPatchField< Type >, fixedValueOutflowFaPatchField< Type >, and genericFaPatchField< Type >.
Definition at line 394 of file faPatchField.H.
References NotImplemented.
Referenced by gaussConvectionScheme< Type >::famDiv().
|
inlinevirtual |
Return the matrix source coefficients corresponding to the evaluation of the value of this patchField with given weights
Reimplemented in calculatedFaPatchField< Type >, coupledFaPatchField< Type >, fixedGradientFaPatchField< Type >, fixedValueFaPatchField< Type >, mixedFaPatchField< Type >, transformFaPatchField< Type >, zeroGradientFaPatchField< Type >, emptyFaPatchField< Type >, clampedPlateFaPatchField< Type >, fixedValueOutflowFaPatchField< Type >, and genericFaPatchField< Type >.
Definition at line 405 of file faPatchField.H.
References NotImplemented.
Referenced by gaussConvectionScheme< Type >::famDiv().
Return the matrix diagonal coefficients corresponding to the evaluation of the gradient of this patchField
Reimplemented in calculatedFaPatchField< Type >, coupledFaPatchField< Type >, fixedGradientFaPatchField< Type >, fixedValueFaPatchField< Type >, mixedFaPatchField< Type >, transformFaPatchField< Type >, transformFaPatchField< Type >, transformFaPatchField< Type >, zeroGradientFaPatchField< Type >, emptyFaPatchField< Type >, clampedPlateFaPatchField< Type >, fixedValueOutflowFaPatchField< Type >, and genericFaPatchField< Type >.
Definition at line 416 of file faPatchField.H.
References NotImplemented.
Referenced by gaussLaplacianScheme< Type >::famLaplacian().
Return the matrix source coefficients corresponding to the evaluation of the gradient of this patchField
Reimplemented in calculatedFaPatchField< Type >, coupledFaPatchField< Type >, fixedGradientFaPatchField< Type >, fixedValueFaPatchField< Type >, mixedFaPatchField< Type >, transformFaPatchField< Type >, zeroGradientFaPatchField< Type >, emptyFaPatchField< Type >, clampedPlateFaPatchField< Type >, fixedValueOutflowFaPatchField< Type >, and genericFaPatchField< Type >.
Definition at line 424 of file faPatchField.H.
References NotImplemented.
Referenced by gaussLaplacianScheme< Type >::famLaplacian().
|
virtual |
Write.
Reimplemented in calculatedFaPatchField< Type >, coupledFaPatchField< Type >, fixedGradientFaPatchField< Type >, fixedValueFaPatchField< Type >, mixedFaPatchField< Type >, clampedPlateFaPatchField< Type >, fixedValueOutflowFaPatchField< Type >, inletOutletFaPatchField< Type >, timeVaryingUniformFixedValueFaPatchField< Type >, and genericFaPatchField< Type >.
Definition at line 212 of file faPatchField.C.
References os(), Foam::type(), and Ostream::writeEntry().
void check | ( | const faPatchField< Type > & | ptf | ) | const |
Check faPatchField<Type> against given faPatchField<Type>
Definition at line 155 of file faPatchField.C.
References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.
Reimplemented in fixedValueFaPatchField< Type >, mixedFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 226 of file faPatchField.C.
References Field< Type >::operator=().
Referenced by clampedPlateFaPatchField< Type >::clampedPlateFaPatchField(), faPatchField< Type >::faPatchField(), inletOutletFaPatchField< Type >::inletOutletFaPatchField(), and zeroGradientFaPatchField< Type >::zeroGradientFaPatchField().
|
virtual |
Reimplemented in fixedValueFaPatchField< Type >, mixedFaPatchField< Type >, transformFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 236 of file faPatchField.C.
References Foam::check(), and Field< Type >::operator=().
|
virtual |
Reimplemented in fixedValueFaPatchField< Type >, mixedFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 247 of file faPatchField.C.
References Foam::check(), and Field< Type >::operator+=().
|
virtual |
Reimplemented in fixedValueFaPatchField< Type >, mixedFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 258 of file faPatchField.C.
References Foam::check(), and Field< Type >::operator-=().
|
virtual |
Reimplemented in fixedValueFaPatchField< Type >, mixedFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 269 of file faPatchField.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and Field< Type >::operator*=().
|
virtual |
Reimplemented in fixedValueFaPatchField< Type >, mixedFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 286 of file faPatchField.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and Field< Type >::operator/=().
Reimplemented in fixedValueFaPatchField< Type >, mixedFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 303 of file faPatchField.C.
References Field< Type >::operator+=().
Reimplemented in fixedValueFaPatchField< Type >, mixedFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 313 of file faPatchField.C.
References Field< Type >::operator-=().
Reimplemented in fixedValueFaPatchField< Type >, mixedFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 323 of file faPatchField.C.
References Field< Type >::operator*=().
Reimplemented in fixedValueFaPatchField< Type >, mixedFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 333 of file faPatchField.C.
References Field< Type >::operator/=().
|
virtual |
Reimplemented in fixedValueFaPatchField< Type >, mixedFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 343 of file faPatchField.C.
|
virtual |
Reimplemented in fixedValueFaPatchField< Type >, mixedFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 353 of file faPatchField.C.
|
virtual |
Reimplemented in fixedValueFaPatchField< Type >, mixedFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 363 of file faPatchField.C.
|
virtual |
Reimplemented in fixedValueFaPatchField< Type >, mixedFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 373 of file faPatchField.C.
References Field< Type >::operator*=(), and s().
|
virtual |
Reimplemented in fixedValueFaPatchField< Type >, mixedFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 383 of file faPatchField.C.
|
virtual |
Definition at line 393 of file faPatchField.C.
References Field< Type >::operator=().
Definition at line 403 of file faPatchField.C.
References Field< Type >::operator=().
|
virtual |
Definition at line 413 of file faPatchField.C.
References Field< Type >::operator=().
Foam::tmp< Foam::faPatchField< Type > > NewCalculatedType | ( | const faPatchField< Type2 > & | pf | ) |
Definition at line 102 of file calculatedFaPatchField.C.
References faPatchField< Type >::patch().
|
friend |
|
static |
Debug switch to disallow the use of.
Definition at line 117 of file faPatchField.H.