Helper class to manage field selections. More...

#include <fieldSelection.H>

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.
virtual	~fieldSelection ()=default
	Destructor.
const List< fieldInfo > &	selection () const noexcept
	The current field selection.
HashSet< wordRe >	filters () const
	Return the current filters.
wordList	selectionNames () const
	Return the current field selection, in sorted order.
virtual bool	resetFieldFilters (const HashSet< wordRe > &names)
	Reset the field filters to the given field names.
virtual bool	resetFieldFilters (const wordRe &name)
	Reset the field filters to the given field name.
virtual bool	read (const dictionary &dict)
	Read the fieldSelection data from dictionary.
virtual bool	containsPattern () const
	Return whether the field names contain a pattern.
virtual void	clearSelection ()
	Clear the current selection.
virtual bool	updateSelection ()
	Update the selection.
virtual bool	checkSelection ()
	Check that all requested fielda have been found.
Public Member Functions inherited from List< fieldInfo >
void	resize (const label len)
autoPtr< List< fieldInfo > >	clone () const
	Clone.
	~List ()
	Destructor.
void	clear ()
	Clear the list, i.e. set size to zero.
void	resize_copy (label count, const label len)
	Change allocated size of list, retaining the first count elements.
void	resize_fill (const label len, const fieldInfo &val)
	Adjust allocated size of list and set val for all elements.
void	resize_nocopy (const label len)
	Adjust allocated size of list without necessarily.
void	transfer (List< fieldInfo > &list)
	Transfer the contents of the argument List into this list and annul the argument list.
fieldInfo &	newElmt (const label i)
	Return subscript-checked element of UList and resizing the list if required.
fieldInfo &	emplace_back (Args &&... args)
	Construct an element at the end of the list, return reference to the new list element.
void	push_back (const fieldInfo &val)
	Append an element at the end of the list.
label	push_uniq (const fieldInfo &val)
	Append an element if not already in the list.
void	pop_back (label n=1)
	Reduce size by 1 or more elements. Can be called on an empty list.
void	operator= (const UList< fieldInfo > &list)
	Assignment to UList operator. Takes linear time.
Istream &	readList (Istream &is)
	Read List from Istream, discarding contents of existing List.
void	shallowCopy (const UList< fieldInfo > &)=delete
	No shallowCopy permitted.
bool	set (const label i, bool val=true)
	A bitSet::set() method for a list of bool.
void	append (const fieldInfo &val)
	Append an element at the end of the list.
label	appendUniq (const fieldInfo &val)
	Same as push_uniq().
void	setSize (label n)
	Alias for resize().
Public Member Functions inherited from UList< fieldInfo >
	UList (const UList< fieldInfo > &) noexcept=default
	Copy construct, shallow copy.
UList< fieldInfo > &	operator= (const UList< fieldInfo > &)=delete
	No copy assignment (default: shallow copy).
label	fcIndex (const label i) const noexcept
	The forward circular index. The next index in the list which returns to the first at the end of the list.
label	rcIndex (const label i) const noexcept
	The reverse circular index. The previous index in the list which returns to the last at the beginning of the list.
const fieldInfo &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list).
const fieldInfo &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list).
const fieldInfo *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage.
fieldInfo *	data () noexcept
	Return pointer to the underlying array serving as data storage.
const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,.
char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,.
fieldInfo &	front ()
	Access first element of the list, position [0].
fieldInfo &	back ()
	Access last element of the list, position [size()-1].
std::streamsize	size_bytes () const noexcept
	Number of contiguous bytes for the List data.
std::streamsize	byteSize () const
	Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous.
void	checkStart (const label start) const
	Check start is within valid range [0,size).
void	checkSize (const label size) const
	Check size is within valid range [0,size].
void	checkRange (const label start, const label len) const
	Check that start and length define a valid range.
void	checkIndex (const label i) const
	Check index is within valid range [0,size).
bool	uniform () const
	True if all entries have identical values, and list is non-empty.
bool	contains (const fieldInfo &val) const
	True if the value is contained in the list.
label	find (const fieldInfo &val) const
	Find index of the first occurrence of the value.
label	rfind (const fieldInfo &val, label pos=-1) const
	Find index of the last occurrence of the value.
void	moveFirst (const label i)
	Move element to the first position.
void	moveLast (const label i)
	Move element to the last position.
void	swapFirst (const label i)
	Swap element with the first element. Fatal on an empty list.
void	swapLast (const label i)
	Swap element with the last element. Fatal on an empty list.
void	shallowCopy (fieldInfo *__restrict__ ptr, const label len) noexcept
	Copy the pointer and size.
void	deepCopy (const UList< fieldInfo > &list)
	Copy elements of the given UList. Sizes must match!
SubList< fieldInfo >	slice (const label pos, label len=-1)
	Return SubList slice (non-const access) - no range checking.
fieldInfo &	operator[] (const label i)
	Return element of UList.
	operator const Foam::List< fieldInfo > & () const
	Allow cast to a const List<T>&.
iterator	begin () noexcept
	Return an iterator to begin traversing the UList.
iterator	end () noexcept
	Return an iterator to end traversing the UList.
const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant UList.
const_iterator	cend () const noexcept
	Return const_iterator to end traversing the constant UList.
reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList.
reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList.
const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList.
bool	empty () const noexcept
	True if List is empty (ie, size() is zero).
label	capacity () const noexcept
	Size of the underlying storage.
void	swap (UList< fieldInfo > &list) noexcept
	Swap content with another UList of the same type in constant time.
bool	operator== (const UList< fieldInfo > &list) const
	Equality operation on ULists of the same type.
bool	operator!= (const UList< fieldInfo > &list) const
	The opposite of the equality operation. Takes linear time.
bool	operator< (const UList< fieldInfo > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator> (const UList< fieldInfo > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator<= (const UList< fieldInfo > &list) const
	Return true if !(a > b). Takes linear time.
bool	operator>= (const UList< fieldInfo > &list) const
	Return true if !(a < b). Takes linear time.
Istream &	readList (Istream &is)
	Read List contents from Istream.
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen.
bool	all () const
	True if all entries are 'true' or if the list is empty.
bool	any () const
	True if any entries are 'true'.
bool	none () const
	True if no entries are 'true'.
bool	test (const label i) const
	Test `bool` value at specified position, always false for out-of-range access.
bool	get (const label i) const
	Return `bool` value at specified position, always false for out-of-range access.
bool	unset (const label i)
	Unset the `bool` entry at specified position, always false for out-of-range access.
std::string_view	view () const
	Return a string_view of the charList. Content is non-modifiable.
fieldInfo &	first ()
	Access first element of the list, position [0].
fieldInfo &	last ()
	Access last element of the list, position [size()-1].
bool	found (const fieldInfo &val, label pos=0) const
	Same as contains().
auto	expr () const
	Wrap value as expression.

Protected Member Functions
template<class Type>
void	addRegistered (DynamicList< fieldInfo > &set) const
	Add registered objects of a given type.
Protected Member Functions inherited from UList< fieldInfo >
void	setAddressableSize (const label n) noexcept
	Set addressed size to be inconsistent with allocated storage.
void	size (const label n)
	Older name for setAddressableSize.
void	writeEntry (Ostream &os) const
	Write the UList with its compound type.
labelRange	validateRange (const labelRange &requestedRange) const
	Return a validated (start,size) subset range, which means that it always addresses a valid section of the list.
void	fill_uniform (const fieldInfo &val)
	Assign all entries to the given value.

Protected Attributes
const objectRegistry &	obr_
	Reference to the database.
const bool	includeComponents_
	Flag to indicate whether components are allowed.
List< fieldInfo >	selection_
	Current field selection.

Additional Inherited Members
Public Types inherited from List< fieldInfo >
typedef SubList< fieldInfo >	subList
	Declare type of subList.
Public Types inherited from UList< fieldInfo >
typedef fieldInfo	value_type
	The value type the list contains.
typedef fieldInfo *	pointer
	The pointer type for non-const access to value_type items.
typedef const fieldInfo *	const_pointer
	The pointer type for const access to value_type items.
typedef fieldInfo &	reference
	The type used for storing into value_type objects.
typedef const fieldInfo &	const_reference
	The type used for reading from constant value_type objects.
typedef fieldInfo *	iterator
	Random access iterator for traversing a UList.
typedef const fieldInfo *	const_iterator
	Random access iterator for traversing a UList.
typedef label	size_type
	The type to represent the size of a UList.
typedef label	difference_type
	The difference between iterator objects.
typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access).
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access).
using	is_List
	Have unique tag.
Static Public Member Functions inherited from List< fieldInfo >
static const List< fieldInfo > &	null () noexcept
	Return a null List (reference to a nullObject). Behaves like an empty List.
Static Public Member Functions inherited from UList< fieldInfo >
static const UList< fieldInfo > &	null () noexcept
	Return a null UList (reference to a nullObject). Behaves like an empty UList.
static constexpr label	max_size () noexcept
	The size of the largest possible UList.

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 60 of file fieldSelection.H.

Constructor & Destructor Documentation

◆ fieldSelection()

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

explicit

Construct from object registry.

Definition at line 27 of file fieldSelection.C.

References includeComponents_, and obr_.

◆ ~fieldSelection()

virtual ~fieldSelection ( )

virtualdefault

Destructor.

Member Function Documentation

◆ addRegistered()

template<class Type>

void addRegistered ( DynamicList< fieldInfo > & set ) const

protected

Add registered objects of a given type.

Definition at line 26 of file fieldSelectionTemplates.C.

References fieldInfo::component(), fieldInfo::found(), fieldInfo::name(), Foam::name(), names, obr_, and List< fieldInfo >::set().

Referenced by volFieldSelection::addRegisteredGeoFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ selection()

const List< fieldInfo > & selection ( ) const

inlinenoexcept

The current field selection.

Definition at line 130 of file fieldSelection.H.

References Foam::noexcept, and selection_.

◆ filters()

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

inline

Return the current filters.

Definition at line 24 of file fieldSelectionI.H.

References fieldInfo::name(), and UList< fieldInfo >::size().

Here is the call graph for this function:

◆ selectionNames()

Foam::wordList selectionNames ( ) const

inline

Return the current field selection, in sorted order.

Definition at line 37 of file fieldSelectionI.H.

References names, selection_, and Foam::sort().

Here is the call 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 108 of file fieldSelection.C.

References names.

Referenced by read().

Here is the caller 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 117 of file fieldSelection.C.

References Foam::name(), and names.

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read the fieldSelection data from dictionary.

Definition at line 130 of file fieldSelection.C.

References dict, fields, and resetFieldFilters().

Here is the call graph for this function:

◆ containsPattern()

bool containsPattern ( ) const

virtual

Return whether the field names contain a pattern.

Definition at line 139 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 153 of file fieldSelection.C.

References selection_.

◆ updateSelection()

bool updateSelection ( )

virtual

Update the selection.

Reimplemented in fileFieldSelection, solverFieldSelection, and volFieldSelection.

Definition at line 159 of file fieldSelection.C.

◆ checkSelection()

bool checkSelection ( )

virtual

Check that all requested fielda have been found.

Definition at line 165 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 85 of file fieldSelection.H.

Referenced by addRegistered(), fieldSelection(), fileFieldSelection::updateSelection(), and solverFieldSelection::updateSelection().

◆ includeComponents_

const bool includeComponents_

protected

Flag to indicate whether components are allowed.

Definition at line 90 of file fieldSelection.H.

Referenced by fieldSelection().

◆ selection_

List<fieldInfo> selection_

protected

Current field selection.

Definition at line 95 of file fieldSelection.H.

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

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

src/finiteVolume/functionObjects/fieldSelections/fieldSelection/fieldSelection.H
src/finiteVolume/functionObjects/fieldSelections/fieldSelection/fieldSelection.C
src/finiteVolume/functionObjects/fieldSelections/fieldSelection/fieldSelectionI.H
src/finiteVolume/functionObjects/fieldSelections/fieldSelection/fieldSelectionTemplates.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ fieldSelection()

◆ ~fieldSelection()

Member Function Documentation

◆ addRegistered()

◆ selection()

◆ filters()

◆ selectionNames()

◆ resetFieldFilters() [1/2]

◆ resetFieldFilters() [2/2]

◆ read()

◆ containsPattern()

◆ clearSelection()

◆ updateSelection()

◆ checkSelection()

Member Data Documentation

◆ obr_

◆ includeComponents_

◆ selection_