NeoFOAM::BoundaryFields< T > Class Template Reference

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

#include <boundaryFields.hpp>

Public Member Functions
	BoundaryFields (const BoundaryFields< T > &rhs)
	Copy constructor.
	BoundaryFields (const Executor &exec, const BoundaryFields< T > &rhs)
	Copy constructor.
	BoundaryFields (const Executor &exec, size_t nBoundaryFaces, size_t nBoundaries)
const NeoFOAM::Field< T > &	value () const
	Get the view storing the computed values from the boundary condition.
NeoFOAM::Field< T > &	value ()
	Get the view storing the computed values from the boundary condition.
const NeoFOAM::Field< T > &	refValue () const
	Get the view storing the Dirichlet boundary values.
NeoFOAM::Field< T > &	refValue ()
	Get the view storing the Dirichlet boundary values.
const NeoFOAM::Field< scalar > &	valueFraction () const
	Get the view storing the fraction of the boundary value.
NeoFOAM::Field< scalar > &	valueFraction ()
	Get the view storing the fraction of the boundary value.
const NeoFOAM::Field< T > &	refGrad () const
	Get the view storing the Neumann boundary values.
NeoFOAM::Field< T > &	refGrad ()
	Get the view storing the Neumann boundary values.
const NeoFOAM::Field< int > &	boundaryTypes () const
	Get the view storing the boundary types.
const NeoFOAM::Field< localIdx > &	offset () const
	Get the view storing the offsets of each boundary.
size_t	nBoundaries () const
	Get the number of boundaries.
size_t	nBoundaryFaces () const
	Get the number of boundary faces.
const Executor &	exec ()
std::pair< localIdx, localIdx >	range (localIdx patchId) const
	Get the range for a given patchId.

Detailed Description

template<typename T>
class NeoFOAM::BoundaryFields< T >

Represents the boundary fields for a computational domain.

The BoundaryFields 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 30 of file boundaryFields.hpp.

Constructor & Destructor Documentation

BoundaryFields() [1/3]

template<typename T >

NeoFOAM::BoundaryFields< T >::BoundaryFields ( const BoundaryFields< T > &  rhs )

inline

Copy constructor.

Parameters

rhs	The boundaryFields object to be copied.

Definition at line 39 of file boundaryFields.hpp.

BoundaryFields() [2/3]

template<typename T >

NeoFOAM::BoundaryFields< T >::BoundaryFields ( const Executor &  exec, const BoundaryFields< T > &  rhs  )

inline

Copy constructor.

Parameters

rhs	The boundaryFields object to be copied.

Definition at line 51 of file boundaryFields.hpp.

BoundaryFields() [3/3]

template<typename T >

NeoFOAM::BoundaryFields< T >::BoundaryFields ( const Executor &  exec, size_t  nBoundaryFaces, size_t  nBoundaries  )

inline

Definition at line 59 of file boundaryFields.hpp.

Member Function Documentation

boundaryTypes()

template<typename T >

const NeoFOAM::Field< int > & NeoFOAM::BoundaryFields< T >::boundaryTypes ( ) const

inline

Get the view storing the boundary types.

Returns

The view storing the boundary types.

Definition at line 108 of file boundaryFields.hpp.

exec()

template<typename T >

const Executor & NeoFOAM::BoundaryFields< T >::exec ( )

inline

Definition at line 128 of file boundaryFields.hpp.

nBoundaries()

template<typename T >

size_t NeoFOAM::BoundaryFields< T >::nBoundaries ( ) const

inline

Get the number of boundaries.

Returns

The number of boundaries.

Definition at line 120 of file boundaryFields.hpp.

nBoundaryFaces()

template<typename T >

size_t NeoFOAM::BoundaryFields< T >::nBoundaryFaces ( ) const

inline

Get the number of boundary faces.

Returns

The number of boundary faces.

Definition at line 126 of file boundaryFields.hpp.

offset()

template<typename T >

const NeoFOAM::Field< localIdx > & NeoFOAM::BoundaryFields< 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 114 of file boundaryFields.hpp.

range()

template<typename T >

std::pair< localIdx, localIdx > NeoFOAM::BoundaryFields< T >::range ( localIdx  patchId ) const

inline

Get the range for a given patchId.

Returns

The number of boundary faces.

Definition at line 134 of file boundaryFields.hpp.

refGrad() [1/2]

template<typename T >

NeoFOAM::Field< T > & NeoFOAM::BoundaryFields< T >::refGrad ( )

inline

Get the view storing the Neumann boundary values.

Returns

The view storing the Neumann boundary values.

Definition at line 102 of file boundaryFields.hpp.

refGrad() [2/2]

template<typename T >

const NeoFOAM::Field< T > & NeoFOAM::BoundaryFields< T >::refGrad ( ) const

inline

Get the view storing the Neumann boundary values.

Returns

The view storing the Neumann boundary values.

Definition at line 96 of file boundaryFields.hpp.

refValue() [1/2]

template<typename T >

NeoFOAM::Field< T > & NeoFOAM::BoundaryFields< T >::refValue ( )

inline

Get the view storing the Dirichlet boundary values.

Returns

The view storing the Dirichlet boundary values.

Definition at line 84 of file boundaryFields.hpp.

refValue() [2/2]

template<typename T >

const NeoFOAM::Field< T > & NeoFOAM::BoundaryFields< T >::refValue ( ) const

inline

Get the view storing the Dirichlet boundary values.

Returns

The view storing the Dirichlet boundary values.

Definition at line 78 of file boundaryFields.hpp.

value() [1/2]

template<typename T >

NeoFOAM::Field< T > & NeoFOAM::BoundaryFields< T >::value ( )

inline

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

Returns

The view storing the computed values.

Definition at line 75 of file boundaryFields.hpp.

value() [2/2]

template<typename T >

const NeoFOAM::Field< T > & NeoFOAM::BoundaryFields< 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 68 of file boundaryFields.hpp.

valueFraction() [1/2]

template<typename T >

NeoFOAM::Field< scalar > & NeoFOAM::BoundaryFields< 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 93 of file boundaryFields.hpp.

valueFraction() [2/2]

template<typename T >

const NeoFOAM::Field< scalar > & NeoFOAM::BoundaryFields< 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 87 of file boundaryFields.hpp.

---

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

• /home/runner/work/NeoFOAM/NeoFOAM/include/NeoFOAM/fields/boundaryFields.hpp