NeoN::BoundaryData< T > Class Template Reference

Represents the boundary fields for a computational domain. More...

#include <boundaryData.hpp>

Public Member Functions
	BoundaryData (const BoundaryData< T > &rhs)
	Copy constructor.
	BoundaryData (const Executor &exec, const BoundaryData< T > &rhs)
	Copy constructor.
	BoundaryData (const Executor &exec, localIdx nBoundaryFaces, localIdx nBoundaryTypes)
	constructor with default initialized Vectors from sizes.
	BoundaryData (const Executor &exec, const std::vector< localIdx > &offsets)
	constructor from a given offsets vector @warn all members except offsets are default constructed
const Vector< T > &	value () const
	Get the view storing the computed values from the boundary condition.
Vector< T > &	value ()
	Get the view storing the computed values from the boundary condition.
const Vector< T > &	refValue () const
	Get the view storing the Dirichlet boundary values.
Vector< T > &	refValue ()
	Get the view storing the Dirichlet boundary values.
const Vector< scalar > &	valueFraction () const
	Get the view storing the fraction of the boundary value.
Vector< scalar > &	valueFraction ()
	Get the view storing the fraction of the boundary value.
const Vector< T > &	refGrad () const
	Get the view storing the Neumann boundary values.
Vector< T > &	refGrad ()
	Get the view storing the Neumann boundary values.
const Vector< int > &	boundaryTypes () const
	Get the view storing the boundary types.
const Vector< localIdx > &	offset () const
	Get the view storing the offsets of each boundary.
localIdx	nBoundaries () const
	Get the number of boundaries.
localIdx	nBoundaryFaces () const
	Get the number of boundary faces.
const Executor &	exec ()
BoundaryData< T > &	operator= (const BoundaryData< T > &rhs)
BoundaryData< T > &	operator= (const BoundaryData< T > &&rhs)
std::pair< localIdx, localIdx >	range (localIdx patchId) const
	Get the range for a given patchId.

Detailed Description

template<typename T>
class NeoN::BoundaryData< T >

Represents the boundary fields for a computational domain.

The BoundaryData class stores the boundary conditions and related information for a computational domain. It provides access to the computed values, reference values, value fractions, reference gradients, boundary types, offsets, and the number of boundaries and boundary faces.

Template Parameters

ValueType

The type of the underlying field values

Definition at line 32 of file boundaryData.hpp.

Constructor & Destructor Documentation

BoundaryData() [1/4]

template<typename T >

NeoN::BoundaryData< T >::BoundaryData ( const BoundaryData< T > &  rhs )

inline

Copy constructor.

Parameters

rhs	The boundaryVectors object to be copied.

Definition at line 41 of file boundaryData.hpp.

BoundaryData() [2/4]

template<typename T >

NeoN::BoundaryData< T >::BoundaryData ( const Executor &  exec, const BoundaryData< T > &  rhs  )

inline

Copy constructor.

Parameters

rhs	The boundaryVectors object to be copied.

Definition at line 53 of file boundaryData.hpp.

BoundaryData() [3/4]

template<typename T >

NeoN::BoundaryData< T >::BoundaryData ( const Executor &  exec, localIdx  nBoundaryFaces, localIdx  nBoundaryTypes  )

inline

constructor with default initialized Vectors from sizes.

Parameters

exec	- The executor
nBoundaryFaces	- The total number of boundary faces
nBoundaryType	- The total number of boundary patches

Definition at line 67 of file boundaryData.hpp.

BoundaryData() [4/4]

template<typename T >

NeoN::BoundaryData< T >::BoundaryData ( const Executor &  exec, const std::vector< localIdx > &  offsets  )

inline

constructor from a given offsets vector @warn all members except offsets are default constructed

Parameters

exec	- The executor
offsets	- The total number of boundary faces

Definition at line 80 of file boundaryData.hpp.

Member Function Documentation

boundaryTypes()

template<typename T >

const Vector< int > & NeoN::BoundaryData< T >::boundaryTypes ( ) const

inline

Get the view storing the boundary types.

Returns

The view storing the boundary types.

Definition at line 128 of file boundaryData.hpp.

exec()

template<typename T >

const Executor & NeoN::BoundaryData< T >::exec ( )

inline

Definition at line 148 of file boundaryData.hpp.

nBoundaries()

template<typename T >

localIdx NeoN::BoundaryData< T >::nBoundaries ( ) const

inline

Get the number of boundaries.

Returns

The number of boundaries.

Definition at line 140 of file boundaryData.hpp.

nBoundaryFaces()

template<typename T >

localIdx NeoN::BoundaryData< T >::nBoundaryFaces ( ) const

inline

Get the number of boundary faces.

Returns

The number of boundary faces.

Definition at line 146 of file boundaryData.hpp.

offset()

template<typename T >

const Vector< localIdx > & NeoN::BoundaryData< T >::offset ( ) const

inline

Get the view storing the offsets of each boundary.

Returns

The view storing the offsets of each boundary.

Definition at line 134 of file boundaryData.hpp.

operator=() [1/2]

template<typename T >

BoundaryData< T > & NeoN::BoundaryData< T >::operator= ( const BoundaryData< T > &&  rhs )

inline

Definition at line 167 of file boundaryData.hpp.

operator=() [2/2]

template<typename T >

BoundaryData< T > & NeoN::BoundaryData< T >::operator= ( const BoundaryData< T > &  rhs )

inline

Definition at line 150 of file boundaryData.hpp.

range()

template<typename T >

std::pair< localIdx, localIdx > NeoN::BoundaryData< T >::range ( localIdx  patchId ) const

inline

Get the range for a given patchId.

Returns

The number of boundary faces.

Definition at line 188 of file boundaryData.hpp.

refGrad() [1/2]

template<typename T >

Vector< T > & NeoN::BoundaryData< T >::refGrad ( )

inline

Get the view storing the Neumann boundary values.

Returns

The view storing the Neumann boundary values.

Definition at line 122 of file boundaryData.hpp.

refGrad() [2/2]

template<typename T >

const Vector< T > & NeoN::BoundaryData< T >::refGrad ( ) const

inline

Get the view storing the Neumann boundary values.

Returns

The view storing the Neumann boundary values.

Definition at line 116 of file boundaryData.hpp.

refValue() [1/2]

template<typename T >

Vector< T > & NeoN::BoundaryData< T >::refValue ( )

inline

Get the view storing the Dirichlet boundary values.

Returns

The view storing the Dirichlet boundary values.

Definition at line 104 of file boundaryData.hpp.

refValue() [2/2]

template<typename T >

const Vector< T > & NeoN::BoundaryData< T >::refValue ( ) const

inline

Get the view storing the Dirichlet boundary values.

Returns

The view storing the Dirichlet boundary values.

Definition at line 98 of file boundaryData.hpp.

value() [1/2]

template<typename T >

Vector< T > & NeoN::BoundaryData< T >::value ( )

inline

Get the view storing the computed values from the boundary condition.

Returns

The view storing the computed values.

Definition at line 95 of file boundaryData.hpp.

value() [2/2]

template<typename T >

const Vector< T > & NeoN::BoundaryData< T >::value ( ) const

inline

Get the view storing the computed values from the boundary condition.

Returns

The view storing the computed values.

Definition at line 88 of file boundaryData.hpp.

valueFraction() [1/2]

template<typename T >

Vector< scalar > & NeoN::BoundaryData< T >::valueFraction ( )

inline

Get the view storing the fraction of the boundary value.

Returns

The view storing the fraction of the boundary value.

Definition at line 113 of file boundaryData.hpp.

valueFraction() [2/2]

template<typename T >

const Vector< scalar > & NeoN::BoundaryData< T >::valueFraction ( ) const

inline

Get the view storing the fraction of the boundary value.

Returns

The view storing the fraction of the boundary value.

Definition at line 107 of file boundaryData.hpp.

---

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

• /home/runner/work/NeoN/NeoN/include/NeoN/fields/boundaryData.hpp