domain::Domain Struct Reference

A wrapper for global ELA data. More...

#include <domain.h>

Inheritance diagram for domain::Domain:

Public Member Functions
	Domain (const int &ni, const int &nj, const int &nk, const int &nn)
	Construct a new Domain object.
fields::Helper< svec::SVector >	getGhost (const Face &f, const int &n)
	From s [n], returns ghost cells immediately adjacent to Face f.
fields::Helper< svec::SVector >	getEdge (const Face &f, const int &n)
	From s [n], returns cells in the domain immediately adjacent to Face f.
constexpr bool	hasNeighbor (Face f) const
	Determine if there is a neighboring domain on the Face f.
template<class T >
T	getMax (const T &in) const
	Get the maximum value across all domains.

Public Attributes
const int	n [3]
	Storage for ni, nj, and nk.
const int &	ni = n[0]
	Number of (non-ghost) cells in first direction.
const int &	nj = n[1]
	Number of (non-ghost) cells in second direction.
const int &	nk = n[2]
	Number of (non-ghost) cells in third direction.
const int	nn
	Number of ELA instances.
std::vector< fields::Owner< svec::SVector > >	s
	Source vector field.
std::vector< fields::Owner< svec::NormalizedSVector > >	c
	Vector dilation field.

Detailed Description

A wrapper for global ELA data.

Constructor & Destructor Documentation

Domain()

domain::Domain::Domain	(	const int &	ni,
		const int &	nj,
		const int &	nk,
		const int &	nn
	)

Construct a new Domain object.

This will allocate s and c with the necessary ghost cells.

Parameters

ni	ni
nj	nj
nk	nk
nn	nn

Member Function Documentation

getEdge()

fields::Helper< svec::SVector > domain::Domain::getEdge	(	const Face &	f,
		const int &	n
	)

From s [n], returns cells in the domain immediately adjacent to Face f.

Parameters

f	The Face
n	Which ELA instance. Required: 0<=n<nn

Returns

fields::Helper<svec::SVector>

getGhost()

fields::Helper< svec::SVector > domain::Domain::getGhost	(	const Face &	f,
		const int &	n
	)

From s [n], returns ghost cells immediately adjacent to Face f.

Parameters

f	The Face
n	Which ELA instance. Required: 0<=n<nn

Returns

fields::Helper<svec::SVector>

getMax()

template<class T >

T domain::Domain::getMax ( const T &  in ) const

inline

Get the maximum value across all domains.

For this base class, there is only one domain, so just returns in

hasNeighbor()

constexpr bool domain::Domain::hasNeighbor ( Face  f ) const

constexpr

Determine if there is a neighboring domain on the Face f.

For this base class, always returns false.

Parameters

f

Member Data Documentation

c

std::vector<fields::Owner<svec::NormalizedSVector> > domain::Domain::c

Vector dilation field.

For each ELA instance, n in 0 to nn -1, the corresponding vector dilation field is accessed through c[n].

s

std::vector<fields::Owner<svec::SVector> > domain::Domain::s

Source vector field.

For each ELA instance, n in 0 to nn -1, the corresponding source vector field is accessed through s[n].

---

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

• /home/runner/work/flexELA/flexELA/src/domain/domain.h