NeoN::finiteVolume::cellCentred::CreateFromExistingVector< VectorType > Class Template Reference

Creates a VectorDocument from an existing field. More...

#include <fieldCollection.hpp>

Public Member Functions
VectorDocument	operator() (Database &db)

Public Attributes
std::string	name
const VectorType &	field
std::int64_t	timeIndex = std::numeric_limits<std::int64_t>::max()
std::int64_t	iterationIndex = std::numeric_limits<std::int64_t>::max()
std::int64_t	subCycleIndex = std::numeric_limits<std::int64_t>::max()

Detailed Description

template<typename VectorType>
class NeoN::finiteVolume::cellCentred::CreateFromExistingVector< VectorType >

Creates a VectorDocument from an existing field.

This functor creates a VectorDocument from an existing field.

Template Parameters

VectorType

The type of the field.

Parameters

name	The name of the field document.
field	The field to create the document from.
timeIndex	The time index of the field document.
iterationIndex	The iteration index of the field document.
subCycleIndex	The sub-cycle index of the field document.

Returns

The created VectorDocument.

Definition at line 369 of file fieldCollection.hpp.

Member Function Documentation

operator()()

template<typename VectorType >

VectorDocument NeoN::finiteVolume::cellCentred::CreateFromExistingVector< VectorType >::operator() ( Database &  db )

inline

Definition at line 379 of file fieldCollection.hpp.

Member Data Documentation

field

template<typename VectorType >

const VectorType& NeoN::finiteVolume::cellCentred::CreateFromExistingVector< VectorType >::field

Definition at line 374 of file fieldCollection.hpp.

iterationIndex

template<typename VectorType >

std::int64_t NeoN::finiteVolume::cellCentred::CreateFromExistingVector< VectorType >::iterationIndex = std::numeric_limits<std::int64_t>::max()

Definition at line 376 of file fieldCollection.hpp.

name

template<typename VectorType >

std::string NeoN::finiteVolume::cellCentred::CreateFromExistingVector< VectorType >::name

Definition at line 373 of file fieldCollection.hpp.

subCycleIndex

template<typename VectorType >

std::int64_t NeoN::finiteVolume::cellCentred::CreateFromExistingVector< VectorType >::subCycleIndex = std::numeric_limits<std::int64_t>::max()

Definition at line 377 of file fieldCollection.hpp.

timeIndex

template<typename VectorType >

std::int64_t NeoN::finiteVolume::cellCentred::CreateFromExistingVector< VectorType >::timeIndex = std::numeric_limits<std::int64_t>::max()

Definition at line 375 of file fieldCollection.hpp.

---

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

• /home/runner/work/NeoN/NeoN/include/NeoN/core/database/fieldCollection.hpp