Grid locations in an axis direction. More...

Inheritance diagram for PDRblock::location:

Collaboration diagram for PDRblock::location:

Public Member Functions
bool	valid () const
	The location list is valid if it contains 2 or more points. More...

label	nCells () const
	The number of cells in this direction. More...

label	nPoints () const
	The number of points in this direction. More...

bool	contains (const scalar p) const
	True if the location is within the range. More...

const scalar &	min () const
	The first() value is considered the min value. More...

const scalar &	max () const
	The last() value is considered the max value. More...

scalar	centre () const
	Mid-point location, zero for an empty list. More...

scalar	length () const
	The difference between min/max values, zero for an empty list. More...

void	checkIndex (const label i) const
	Check that element index is within valid range. More...

scalar	width (const label i) const
	Cell size at element position. More...

scalar	C (const label i) const
	Cell centre at element position. More...

scalarMinMax	edgeLimits () const
	Return min/max edge lengths. More...

gradingDescriptors	grading () const
	Return edge grading descriptors for the locations. More...

label	findCell (const scalar p) const
	Find the cell index enclosing this location. More...

label	findIndex (const scalar p, const scalar tol) const
	Find the grid index, within the given tolerance. More...

const scalar &	clip (const scalar &val) const

Public Member Functions inherited from List< scalar >
constexpr	List () noexcept
	Default construct. More...

	List (const label len)
	Construct with given size. More...

	List (const label len, const scalar &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 scalar &val)
	Construct with length=1, copying the value as the only content. More...

	List (const Foam::one, scalar &&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< scalar > &a)
	Copy construct from list. More...

	List (const UList< scalar > &a)
	Copy construct contents from list. More...

	List (List< scalar > &a, bool reuse)
	Construct as copy or re-use as specified. More...

	List (const UList< scalar > &list, const labelUList &indices)
	Copy construct subset of list. More...

	List (const UList< scalar > &list, const FixedList< label, N > &indices)
	Copy construct subset of list. More...

	List (const FixedList< scalar, N > &list)
	Construct as copy of FixedList<T, N> More...

	List (const PtrList< scalar > &list)
	Construct as copy of PtrList<T> More...

	List (const SLList< scalar > &list)
	Construct as copy of SLList<T> More...

	List (const IndirectListBase< scalar, Addr > &list)
	Construct as copy of IndirectList contents. More...

	List (std::initializer_list< scalar > list)
	Construct from an initializer list. More...

	List (List< scalar > &&list)
	Move construct from List. More...

	List (DynamicList< scalar, SizeMin > &&list)
	Move construct from DynamicList. More...

	List (SLList< scalar > &&list)
	Move construct from SLList. More...

	List (Istream &is)
	Construct from Istream. More...

autoPtr< List< scalar > >	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 scalar &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 scalar &val)
	Alias for resize() More...

void	append (const scalar &val)
	Append an element at the end of the list. More...

void	append (scalar &&val)
	Move append an element at the end of the list. More...

void	append (const UList< scalar > &list)
	Append a List to the end of this list. More...

void	append (const IndirectListBase< scalar, Addr > &list)
	Append IndirectList contents at the end of this list. More...

label	appendUniq (const scalar &val)
	Append an element if not already in the list. More...

void	transfer (List< scalar > &list)

void	transfer (DynamicList< scalar, SizeMin > &list)

scalar &	newElmt (const label i)

void	operator= (const UList< scalar > &a)
	Assignment to UList operator. Takes linear time. More...

void	operator= (const List< scalar > &list)
	Assignment operator. Takes linear time. More...

void	operator= (const SLList< scalar > &list)
	Assignment to SLList operator. Takes linear time. More...

void	operator= (const IndirectListBase< scalar, Addr > &list)
	Assignment from IndirectList. Takes linear time. More...

void	operator= (const FixedList< scalar, N > &list)
	Copy assignment from FixedList. More...

void	operator= (std::initializer_list< scalar > list)
	Assignment to an initializer list. More...

void	operator= (const scalar &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< scalar > &&list)
	Move assignment. Takes constant time. More...

void	operator= (DynamicList< scalar, SizeMin > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SLList< scalar > &&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< scalar > &)=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)

Additional Inherited Members
Public Types inherited from List< scalar >
typedef SubList< scalar >	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...

Static Public Member Functions inherited from List< scalar >
static const List< scalar > &	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...

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

Detailed Description

Grid locations in an axis direction.

The number of points is one larger than the number of elements it represents

Definition at line 178 of file PDRblock.H.

Member Function Documentation

◆ valid()

bool valid ( ) const

inline

The location list is valid if it contains 2 or more points.

Definition at line 31 of file PDRblockI.H.

References interfaceDefinitions::size().

Here is the call graph for this function:

◆ nCells()

Foam::label nCells ( ) const

inline

The number of cells in this direction.

Definition at line 37 of file PDRblockI.H.

References interfaceDefinitions::size().

Here is the call graph for this function:

◆ nPoints()

Foam::label nPoints ( ) const

inline

The number of points in this direction.

Definition at line 43 of file PDRblockI.H.

References interfaceDefinitions::size().

Here is the call graph for this function:

◆ contains()

bool contains ( const scalar p ) const

inline

True if the location is within the range.

Definition at line 49 of file PDRblockI.H.

References p, and interfaceDefinitions::size().

Here is the call graph for this function:

◆ min()

const Foam::scalar & min ( ) const

inline

The first() value is considered the min value.

Definition at line 55 of file PDRblockI.H.

References interfaceDefinitions::empty().

Here is the call graph for this function:

◆ max()

const Foam::scalar & max ( ) const

inline

The last() value is considered the max value.

Definition at line 61 of file PDRblockI.H.

References interfaceDefinitions::empty().

Here is the call graph for this function:

◆ centre()

Foam::scalar centre ( ) const

inline

Mid-point location, zero for an empty list.

Definition at line 67 of file PDRblockI.H.

References interfaceDefinitions::empty().

Here is the call graph for this function:

◆ length()

Foam::scalar length ( ) const

inline

The difference between min/max values, zero for an empty list.

Definition at line 73 of file PDRblockI.H.

References interfaceDefinitions::empty(), and Foam::mag().

Here is the call graph for this function:

◆ checkIndex()

void checkIndex ( const label i ) const

inline

Check that element index is within valid range.

Definition at line 79 of file PDRblockI.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, ijkMesh::nCells(), and Foam::nl.

Here is the call graph for this function:

◆ width()

Foam::scalar width ( const label i ) const

inline

Cell size at element position.

Definition at line 91 of file PDRblockI.H.

References ijkAddressing::checkIndex().

Here is the call graph for this function:

◆ C()

Foam::scalar C ( const label i ) const

inline

Cell centre at element position.

Treats -1 and nCells positions like a halo cell.

Definition at line 101 of file PDRblockI.H.

References ijkAddressing::checkIndex(), and interfaceDefinitions::size().

Here is the call graph for this function:

◆ edgeLimits()

Foam::scalarMinMax edgeLimits ( ) const

Return min/max edge lengths.

Definition at line 263 of file PDRblockLocation.C.

References MinMax< T >::add().

Here is the call graph for this function:

◆ grading()

gradingDescriptors grading ( ) const

Return edge grading descriptors for the locations.

See also: Foam::gradingDescriptor

◆ findCell()

Foam::label findCell ( const scalar p ) const

Find the cell index enclosing this location.

Returns: -1 for out-of-bounds

Definition at line 276 of file PDRblockLocation.C.

References interfaceDefinitions::empty(), Foam::equal(), Foam::findLower(), and p.

Here is the call graph for this function:

◆ findIndex()

Foam::label findIndex	(	const scalar	p,
		const scalar	tol
	)		const

Find the grid index, within the given tolerance.

Return -1 for out-of-bounds and -2 for a point that is within bounds, but not aligned with a grid point.

Definition at line 302 of file PDRblockLocation.C.

References delta, Foam::diff(), interfaceDefinitions::empty(), Foam::mag(), p, and interfaceDefinitions::size().

Here is the call graph for this function:

◆ clip()

const Foam::scalar & clip ( const scalar & val ) const

inline

If out of range, return the respective min/max limits, otherwise return the value itself.

If the range is invalid, always return the value.

Definition at line 127 of file PDRblockI.H.

References interfaceDefinitions::size().

Here is the call graph for this function:

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

src/mesh/blockMesh/PDRblockMesh/PDRblock.H
src/mesh/blockMesh/PDRblockMesh/PDRblockI.H
src/mesh/blockMesh/PDRblockMesh/PDRblockLocation.C

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ valid()

◆ nCells()

◆ nPoints()

◆ contains()

◆ min()

◆ max()

◆ centre()

◆ length()

◆ checkIndex()

◆ width()

◆ C()

◆ edgeLimits()

◆ grading()

◆ findCell()

◆ findIndex()

◆ clip()