fieldSelection Class Reference

Helper class to manage field selections. More...

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

Public Member Functions

 fieldSelection (const objectRegistry &obr, const bool includeComponents=false)
 Construct from object registry. More...
 
virtual ~fieldSelection ()=default
 Destructor. More...
 
HashSet< wordRefilters () const
 Return the cuurent filters. More...
 
const List< fieldInfo > & selection () const
 
wordHashSet selectionNames () const
 Return the current field selection. More...
 
virtual bool resetFieldFilters (const HashSet< wordRe > &names)
 Reset the field filters to the given field names. More...
 
virtual bool resetFieldFilters (const wordRe &name)
 Reset the field filters to the given field name. More...
 
virtual bool read (const dictionary &dict)
 Read the fieldSelection data from dictionary. More...
 
virtual bool containsPattern () const
 Return whether the field names contain a pattern. More...
 
virtual void clearSelection ()
 Clear the current selection. More...
 
virtual bool updateSelection ()
 Update the selection. More...
 
virtual bool checkSelection ()
 Check that all requested fielda have been found. More...
 
- Public Member Functions inherited from List< fieldInfo >
constexpr List () noexcept
 Default construct. More...
 
 List (const label len)
 Construct with given size. More...
 
 List (const label len, const fieldInfo &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 fieldInfo &val)
 Construct with length=1, copying the value as the only content. More...
 
 List (const Foam::one, fieldInfo &&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< fieldInfo > &a)
 Copy construct from list. More...
 
 List (const UList< fieldInfo > &a)
 Copy construct contents from list. More...
 
 List (List< fieldInfo > &a, bool reuse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< fieldInfo > &list, const labelUList &indices)
 Copy construct subset of list. More...
 
 List (const UList< fieldInfo > &list, const FixedList< label, N > &indices)
 Copy construct subset of list. More...
 
 List (const FixedList< fieldInfo, N > &list)
 Construct as copy of FixedList<T, N> More...
 
 List (const PtrList< fieldInfo > &list)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< fieldInfo > &list)
 Construct as copy of SLList<T> More...
 
 List (const IndirectListBase< fieldInfo, Addr > &list)
 Construct as copy of IndirectList contents. More...
 
 List (std::initializer_list< fieldInfo > list)
 Construct from an initializer list. More...
 
 List (List< fieldInfo > &&list)
 Move construct from List. More...
 
 List (DynamicList< fieldInfo, SizeMin > &&list)
 Move construct from DynamicList. More...
 
 List (SLList< fieldInfo > &&list)
 Move construct from SLList. More...
 
 List (Istream &is)
 Construct from Istream. More...
 
autoPtr< List< fieldInfo > > 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 fieldInfo &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 fieldInfo &val)
 Alias for resize() More...
 
void append (const fieldInfo &val)
 Append an element at the end of the list. More...
 
void append (fieldInfo &&val)
 Move append an element at the end of the list. More...
 
void append (const UList< fieldInfo > &list)
 Append a List to the end of this list. More...
 
void append (const IndirectListBase< fieldInfo, Addr > &list)
 Append IndirectList contents at the end of this list. More...
 
label appendUniq (const fieldInfo &val)
 Append an element if not already in the list. More...
 
void transfer (List< fieldInfo > &list)
 
void transfer (DynamicList< fieldInfo, SizeMin > &list)
 
fieldInfo & newElmt (const label i)
 
void operator= (const UList< fieldInfo > &a)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const List< fieldInfo > &list)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< fieldInfo > &list)
 Assignment to SLList operator. Takes linear time. More...
 
void operator= (const IndirectListBase< fieldInfo, Addr > &list)
 Assignment from IndirectList. Takes linear time. More...
 
void operator= (const FixedList< fieldInfo, N > &list)
 Copy assignment from FixedList. More...
 
void operator= (std::initializer_list< fieldInfo > list)
 Assignment to an initializer list. More...
 
void operator= (const fieldInfo &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< fieldInfo > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (DynamicList< fieldInfo, SizeMin > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (SLList< fieldInfo > &&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< fieldInfo > &)=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)
 

Protected Member Functions

template<class Type >
void addRegistered (DynamicList< fieldInfo > &set) const
 Add registered objects of a given type. More...
 
- 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
 

Protected Attributes

const objectRegistryobr_
 Reference to the database. More...
 
const bool includeComponents_
 Flag to indicate whether components are allowed. More...
 
List< fieldInfoselection_
 Current field selection. More...
 

Additional Inherited Members

- Public Types inherited from List< fieldInfo >
typedef SubList< fieldInfo > 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...
 
- Static Public Member Functions inherited from List< fieldInfo >
static const List< fieldInfo > & 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...
 

Detailed Description

Helper class to manage field selections.

The class holds a list of field name filters which are then applied to a set of field objects (in derived classes) from which the resulting set is available via the selection() function. This returns a list of (fieldName, component) objects, e.g. for U.component(0) this is (U, 0).

Source files

Definition at line 63 of file fieldSelection.H.

Constructor & Destructor Documentation

◆ fieldSelection()

fieldSelection ( const objectRegistry obr,
const bool  includeComponents = false 
)

Construct from object registry.

Definition at line 34 of file fieldSelection.C.

◆ ~fieldSelection()

virtual ~fieldSelection ( )
virtualdefault

Destructor.

Member Function Documentation

◆ addRegistered()

void addRegistered ( DynamicList< fieldInfo > &  set) const
protected

Add registered objects of a given type.

Definition at line 33 of file fieldSelectionTemplates.C.

References fieldInfo::component(), fieldInfo::found(), fieldInfo::name(), Foam::name(), objectRegistry::names(), fieldSelection::obr_, List< fieldInfo >::set(), and UList< T >::size().

Here is the call graph for this function:

◆ filters()

Foam::HashSet< Foam::wordRe > filters ( ) const
inline

Return the cuurent filters.

Definition at line 29 of file fieldSelectionI.H.

References f(), and fieldInfo::name().

Here is the call graph for this function:

◆ selection()

const Foam::List< Foam::functionObjects::fieldInfo > & selection ( ) const
inline

Definition at line 43 of file fieldSelectionI.H.

◆ selectionNames()

Foam::wordHashSet selectionNames ( ) const
inline

Return the current field selection.

Definition at line 50 of file fieldSelectionI.H.

Referenced by fieldExtents::writeFileHeader(), fieldMinMax::writeFileHeader(), and solverInfo::writeFileHeader().

Here is the caller graph for this function:

◆ resetFieldFilters() [1/2]

bool resetFieldFilters ( const HashSet< wordRe > &  names)
virtual

Reset the field filters to the given field names.

Definition at line 47 of file fieldSelection.C.

References DynamicList< T, SizeMin >::append(), Foam::component(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, n, Foam::name(), Foam::nl, formatter::npos, Foam::readLabel(), and UList< T >::size().

Here is the call graph for this function:

◆ resetFieldFilters() [2/2]

bool resetFieldFilters ( const wordRe name)
virtual

Reset the field filters to the given field name.

Definition at line 114 of file fieldSelection.C.

References Foam::name().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary dict)
virtual

Read the fieldSelection data from dictionary.

Definition at line 125 of file fieldSelection.C.

References dict, and fields.

Referenced by equationInitialResidualCondition::equationInitialResidualCondition().

Here is the caller graph for this function:

◆ containsPattern()

bool containsPattern ( ) const
virtual

Return whether the field names contain a pattern.

Definition at line 133 of file fieldSelection.C.

References wordRe::isPattern(), and fieldInfo::name().

Here is the call graph for this function:

◆ clearSelection()

void clearSelection ( )
virtual

Clear the current selection.

Definition at line 147 of file fieldSelection.C.

◆ updateSelection()

bool updateSelection ( )
virtual

Update the selection.

Reimplemented in fileFieldSelection, solverFieldSelection, and volFieldSelection.

Definition at line 153 of file fieldSelection.C.

◆ checkSelection()

bool checkSelection ( )
virtual

Check that all requested fielda have been found.

Definition at line 159 of file fieldSelection.C.

References Foam::endl(), fieldInfo::found(), fieldInfo::name(), and WarningInFunction.

Referenced by fileFieldSelection::updateSelection(), solverFieldSelection::updateSelection(), and volFieldSelection::updateSelection().

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

Member Data Documentation

◆ obr_

const objectRegistry& obr_
protected

Reference to the database.

Definition at line 80 of file fieldSelection.H.

Referenced by fieldSelection::addRegistered().

◆ includeComponents_

const bool includeComponents_
protected

Flag to indicate whether components are allowed.

Definition at line 83 of file fieldSelection.H.

◆ selection_

List<fieldInfo> selection_
protected

Current field selection.

Definition at line 86 of file fieldSelection.H.


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