gradingDescriptors Class Reference

List of gradingDescriptor for the sections of a block with additional IO functionality. More...

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

Public Member Functions

 gradingDescriptors ()
 Default construct with a single default gradingDescriptor. More...
 
 gradingDescriptors (const label len)
 Construct with specified number of default gradingDescriptor. More...
 
 gradingDescriptors (const gradingDescriptor &gd)
 Construct from a single gradingDescriptor. More...
 
void correct ()
 Adjust expansion ratios. More...
 
void normalise ()
 
gradingDescriptors inv () const
 Return the inverse gradingDescriptors with 1/expansionRatio. More...
 
- Public Member Functions inherited from List< gradingDescriptor >
constexpr List () noexcept
 Default construct. More...
 
 List (const label len)
 Construct with given size. More...
 
 List (const label len, const gradingDescriptor &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 gradingDescriptor &val)
 Construct with length=1, copying the value as the only content. More...
 
 List (const Foam::one, gradingDescriptor &&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< gradingDescriptor > &a)
 Copy construct from list. More...
 
 List (const UList< gradingDescriptor > &a)
 Copy construct contents from list. More...
 
 List (List< gradingDescriptor > &a, bool reuse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< gradingDescriptor > &list, const labelUList &indices)
 Copy construct subset of list. More...
 
 List (const UList< gradingDescriptor > &list, const FixedList< label, N > &indices)
 Copy construct subset of list. More...
 
 List (const FixedList< gradingDescriptor, N > &list)
 Construct as copy of FixedList<T, N> More...
 
 List (const PtrList< gradingDescriptor > &list)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< gradingDescriptor > &list)
 Construct as copy of SLList<T> More...
 
 List (const IndirectListBase< gradingDescriptor, Addr > &list)
 Construct as copy of IndirectList contents. More...
 
 List (std::initializer_list< gradingDescriptor > list)
 Construct from an initializer list. More...
 
 List (List< gradingDescriptor > &&list)
 Move construct from List. More...
 
 List (DynamicList< gradingDescriptor, SizeMin > &&list)
 Move construct from DynamicList. More...
 
 List (SortableList< gradingDescriptor > &&list)
 Move construct from SortableList. More...
 
 List (SLList< gradingDescriptor > &&list)
 Move construct from SLList. More...
 
 List (Istream &is)
 Construct from Istream. More...
 
autoPtr< List< gradingDescriptor > > 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 gradingDescriptor &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 gradingDescriptor &val)
 Alias for resize() More...
 
void append (const gradingDescriptor &val)
 Append an element at the end of the list. More...
 
void append (gradingDescriptor &&val)
 Move append an element at the end of the list. More...
 
void append (const UList< gradingDescriptor > &list)
 Append a List to the end of this list. More...
 
void append (const IndirectListBase< gradingDescriptor, Addr > &list)
 Append IndirectList contents at the end of this list. More...
 
label appendUniq (const gradingDescriptor &val)
 Append an element if not already in the list. More...
 
void transfer (List< gradingDescriptor > &list)
 
void transfer (DynamicList< gradingDescriptor, SizeMin > &list)
 
void transfer (SortableList< gradingDescriptor > &list)
 
gradingDescriptornewElmt (const label i)
 
void operator= (const UList< gradingDescriptor > &a)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const List< gradingDescriptor > &list)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< gradingDescriptor > &list)
 Assignment to SLList operator. Takes linear time. More...
 
void operator= (const IndirectListBase< gradingDescriptor, Addr > &list)
 Assignment from IndirectList. Takes linear time. More...
 
void operator= (const FixedList< gradingDescriptor, N > &list)
 Copy assignment from FixedList. More...
 
void operator= (std::initializer_list< gradingDescriptor > list)
 Assignment to an initializer list. More...
 
void operator= (const gradingDescriptor &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< gradingDescriptor > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (DynamicList< gradingDescriptor, SizeMin > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (SortableList< gradingDescriptor > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (SLList< gradingDescriptor > &&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< gradingDescriptor > &)=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...
 

Friends

Istreamoperator>> (Istream &, gradingDescriptors &)
 

Additional Inherited Members

- Public Types inherited from List< gradingDescriptor >
typedef SubList< gradingDescriptorsubList
 Declare type of subList. More...
 
- Static Public Member Functions inherited from List< gradingDescriptor >
static const List< gradingDescriptor > & null ()
 Return a null List. More...
 

Detailed Description

List of gradingDescriptor for the sections of a block with additional IO functionality.

Source files

Definition at line 58 of file gradingDescriptors.H.

Constructor & Destructor Documentation

◆ gradingDescriptors() [1/3]

Default construct with a single default gradingDescriptor.

Definition at line 33 of file gradingDescriptors.C.

◆ gradingDescriptors() [2/3]

gradingDescriptors ( const label  len)
explicit

Construct with specified number of default gradingDescriptor.

Definition at line 40 of file gradingDescriptors.C.

◆ gradingDescriptors() [3/3]

gradingDescriptors ( const gradingDescriptor gd)
explicit

Construct from a single gradingDescriptor.

Definition at line 48 of file gradingDescriptors.C.

Member Function Documentation

◆ correct()

void correct ( )

Adjust expansion ratios.

Trap negative value and treat as its inverse.

Definition at line 56 of file gradingDescriptors.C.

References gradingDescriptor::correct().

Referenced by Foam::operator>>().

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

◆ normalise()

void normalise ( )

Normalize blockFractions and nDivFractions for the list of gradingDescriptors, and call correct()

Definition at line 65 of file gradingDescriptors.C.

References gradingDescriptor::correct().

Referenced by Foam::operator>>().

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

◆ inv()

Foam::gradingDescriptors inv ( ) const

Return the inverse gradingDescriptors with 1/expansionRatio.

Definition at line 85 of file gradingDescriptors.C.

References forAll, and Foam::inv().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator>>

Istream& operator>> ( Istream ,
gradingDescriptors  
)
friend

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