NeoN::Field< ValueType > Class Template Reference

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

#include <field.hpp>

Public Member Functions
	Field (const Executor &exec)
	Field (const Executor &exec, localIdx nCells, const std::vector< localIdx > &offsets)
	Field (const Executor &exec, const Vector< ValueType > &internalVector, const BoundaryData< ValueType > &boundaryData)
	Field (const Executor &exec, const Vector< ValueType > &internalVector, std::vector< localIdx > offsets)
	Field (const Executor &exec, localIdx internalSize, localIdx boundarySize)
	Field (const Field< ValueType > &rhs)
	Field (Field< ValueType > &&rhs)
Field< ValueType > &	operator= (const Field< ValueType > &rhs)
Field< ValueType > &	operator= (Field< ValueType > &&rhs)
const Vector< ValueType > &	internalVector () const
Vector< ValueType > &	internalVector ()
const BoundaryData< ValueType > &	boundaryData () const
BoundaryData< ValueType > &	boundaryData ()
const Executor &	exec () const

Detailed Description

template<typename ValueType>
class NeoN::Field< ValueType >

Represents the domain fields for a computational domain.

The Field class stores the internal fields and boundary 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 33 of file field.hpp.

Constructor & Destructor Documentation

Field() [1/7]

template<typename ValueType >

NeoN::Field< ValueType >::Field ( const Executor &  exec )

inline

Definition at line 37 of file field.hpp.

Field() [2/7]

template<typename ValueType >

NeoN::Field< ValueType >::Field ( const Executor &  exec, localIdx  nCells, const std::vector< localIdx > &  offsets  )

inline

Definition at line 40 of file field.hpp.

Field() [3/7]

template<typename ValueType >

NeoN::Field< ValueType >::Field ( const Executor &  exec, const Vector< ValueType > &  internalVector, const BoundaryData< ValueType > &  boundaryData  )

inline

Definition at line 44 of file field.hpp.

Field() [4/7]

template<typename ValueType >

NeoN::Field< ValueType >::Field ( const Executor &  exec, const Vector< ValueType > &  internalVector, std::vector< localIdx >  offsets  )

inline

Definition at line 52 of file field.hpp.

Field() [5/7]

template<typename ValueType >

NeoN::Field< ValueType >::Field ( const Executor &  exec, localIdx  internalSize, localIdx  boundarySize  )

inline

Definition at line 58 of file field.hpp.

Field() [6/7]

template<typename ValueType >

NeoN::Field< ValueType >::Field ( const Field< ValueType > &  rhs )

inline

Definition at line 63 of file field.hpp.

Field() [7/7]

template<typename ValueType >

NeoN::Field< ValueType >::Field ( Field< ValueType > &&  rhs )

inline

Definition at line 68 of file field.hpp.

Member Function Documentation

boundaryData() [1/2]

template<typename ValueType >

BoundaryData< ValueType > & NeoN::Field< ValueType >::boundaryData ( )

inline

Definition at line 99 of file field.hpp.

boundaryData() [2/2]

template<typename ValueType >

const BoundaryData< ValueType > & NeoN::Field< ValueType >::boundaryData ( ) const

inline

Definition at line 96 of file field.hpp.

exec()

template<typename ValueType >

const Executor & NeoN::Field< ValueType >::exec ( ) const

inline

Definition at line 101 of file field.hpp.

internalVector() [1/2]

template<typename ValueType >

Vector< ValueType > & NeoN::Field< ValueType >::internalVector ( )

inline

Definition at line 93 of file field.hpp.

internalVector() [2/2]

template<typename ValueType >

const Vector< ValueType > & NeoN::Field< ValueType >::internalVector ( ) const

inline

Definition at line 90 of file field.hpp.

operator=() [1/2]

template<typename ValueType >

Field< ValueType > & NeoN::Field< ValueType >::operator= ( const Field< ValueType > &  rhs )

inline

Definition at line 74 of file field.hpp.

operator=() [2/2]

template<typename ValueType >

Field< ValueType > & NeoN::Field< ValueType >::operator= ( Field< ValueType > &&  rhs )

inline

Definition at line 82 of file field.hpp.

---

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

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