PDRblock::gridControl Struct Reference
Inheritance diagram for PDRblock::gridControl:
[legend]
Collaboration diagram for PDRblock::gridControl:
[legend]

Public Member Functions

label nCells () const
 Total number of cells in this direction. More...
 
gradingDescriptors grading () const
 Return edge grading descriptors for the locations. More...
 
void resize (label len)
 Resize lists. More...
 
void append (const scalar p, label nDiv, scalar expRatio=1)
 Add point/divisions/expand to end of list (push_back) More...
 
void prepend (const scalar p, label nDiv, scalar expRatio=1)
 Add point/divisions/expand to front of list (push_front) More...
 
void writeDict (Ostream &os, const direction cmpt) const
 Write as dictionary contents for specified vector direction. More...
 
- Public Member Functions inherited from List< T >
constexpr List () noexcept
 Default construct. More...
 
 List (const label len)
 Construct with given size. More...
 
 List (const label len, const T &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 T &val)
 Construct with length=1, copying the value as the only content. More...
 
 List (const Foam::one, T &&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< T > &a)
 Copy construct from list. More...
 
 List (const UList< T > &a)
 Copy construct contents from list. More...
 
 List (List< T > &a, bool reuse)
 Construct as copy or re-use as specified. More...
 
 List (const UList< T > &list, const labelUList &indices)
 Copy construct subset of list. More...
 
template<unsigned N>
 List (const UList< T > &list, const FixedList< label, N > &indices)
 Copy construct subset of list. More...
 
template<unsigned N>
 List (const FixedList< T, N > &list)
 Construct as copy of FixedList<T, N> More...
 
 List (const PtrList< T > &list)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< T > &list)
 Construct as copy of SLList<T> More...
 
template<class Addr >
 List (const IndirectListBase< T, Addr > &list)
 Construct as copy of IndirectList contents. More...
 
 List (std::initializer_list< T > list)
 Construct from an initializer list. More...
 
 List (List< T > &&list)
 Move construct from List. More...
 
template<int SizeMin>
 List (DynamicList< T, SizeMin > &&list)
 Move construct from DynamicList. More...
 
 List (SortableList< T > &&list)
 Move construct from SortableList. More...
 
 List (SLList< T > &&list)
 Move construct from SLList. More...
 
 List (Istream &is)
 Construct from Istream. More...
 
autoPtr< List< T > > 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 T &val)
 Adjust allocated size of list and set val for new elements. More...
 
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 T &val)
 Alias for resize() More...
 
void append (const T &val)
 Append an element at the end of the list. More...
 
void append (T &&val)
 Move append an element at the end of the list. More...
 
void append (const UList< T > &list)
 Append a List to the end of this list. More...
 
template<class Addr >
void append (const IndirectListBase< T, Addr > &list)
 Append IndirectList contents at the end of this list. More...
 
label appendUniq (const T &val)
 Append an element if not already in the list. More...
 
void transfer (List< T > &list)
 
template<int SizeMin>
void transfer (DynamicList< T, SizeMin > &list)
 
void transfer (SortableList< T > &list)
 
TnewElmt (const label i)
 
void operator= (const UList< T > &a)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const List< T > &list)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< T > &list)
 Assignment to SLList operator. Takes linear time. More...
 
template<class Addr >
void operator= (const IndirectListBase< T, Addr > &list)
 Assignment from IndirectList. Takes linear time. More...
 
template<unsigned N>
void operator= (const FixedList< T, N > &list)
 Copy assignment from FixedList. More...
 
void operator= (std::initializer_list< T > list)
 Assignment to an initializer list. 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...
 
void operator= (List< T > &&list)
 Move assignment. Takes constant time. More...
 
template<int SizeMin>
void operator= (DynamicList< T, SizeMin > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (SortableList< T > &&list)
 Move assignment. Takes constant time. More...
 
void operator= (SLList< T > &&list)
 Move assignment. Takes constant time. More...
 
IstreamreadList (Istream &is)
 Read List from Istream, discarding contents of existing List. More...
 
void shallowCopy (const UList< T > &)=delete
 No shallowCopy permitted. More...
 
template<class TypeT = T>
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...
 
template<>
IstreamreadList (Istream &is)
 
template<>
void resize (const label newLen)
 
template<>
IstreamreadList (Istream &is)
 

Public Attributes

labelList divisions_
 The number of division per segment. More...
 
scalarList expansion_
 The expansion ratio per segment. More...
 

Additional Inherited Members

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

Detailed Description

The begin/end nodes for each segment, with divisions and expansion for each segment

Not normally used outside of PDRblock

Definition at line 244 of file PDRblock.H.

Member Function Documentation

◆ nCells()

Foam::label nCells ( ) const

Total number of cells in this direction.

Definition at line 96 of file PDRblockLocation.C.

◆ grading()

Foam::gradingDescriptors grading ( ) const

Return edge grading descriptors for the locations.

See also
Foam::gradingDescriptor

Construct from components

Definition at line 108 of file PDRblockLocation.C.

References forAll.

◆ resize()

void resize ( label  len)

Resize lists.

Definition at line 132 of file PDRblockLocation.C.

References Foam::max(), List< T >::resize(), and Foam::Zero.

Here is the call graph for this function:

◆ append()

void append ( const scalar  p,
label  nDiv,
scalar  expRatio = 1 
)

Add point/divisions/expand to end of list (push_back)

Definition at line 147 of file PDRblockLocation.C.

References List< T >::append(), Foam::endl(), Foam::equal(), p, and WarningInFunction.

Here is the call graph for this function:

◆ prepend()

void prepend ( const scalar  p,
label  nDiv,
scalar  expRatio = 1 
)

Add point/divisions/expand to front of list (push_front)

Definition at line 190 of file PDRblockLocation.C.

References Foam::endl(), Foam::equal(), p, Foam::prependList(), and WarningInFunction.

Here is the call graph for this function:

◆ writeDict()

void writeDict ( Ostream os,
const direction  cmpt 
) const

Write as dictionary contents for specified vector direction.

Definition at line 233 of file PDRblockLocation.C.

References Ostream::beginBlock(), VectorSpace< Vector< scalar >, scalar, 3 >::componentNames, token::END_STATEMENT, Ostream::endBlock(), Foam::flatOutput(), Foam::indent(), VectorSpace< Vector< scalar >, scalar, 3 >::nComponents, Foam::nl, and os().

Here is the call graph for this function:

Member Data Documentation

◆ divisions_

labelList divisions_

The number of division per segment.

Definition at line 249 of file PDRblock.H.

◆ expansion_

scalarList expansion_

The expansion ratio per segment.

Definition at line 252 of file PDRblock.H.


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