NeoFOAM::finiteVolume::cellCentred::CreateFromExistingField< FieldType > Class Template Reference

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

#include <fieldCollection.hpp>

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

Public Attributes
std::string	name
const FieldType &	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 FieldType>
class NeoFOAM::finiteVolume::cellCentred::CreateFromExistingField< FieldType >

Creates a FieldDocument from an existing field.

This functor creates a FieldDocument from an existing field.

Template Parameters

FieldType

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 FieldDocument.

Definition at line 365 of file fieldCollection.hpp.

Member Function Documentation

operator()()

template<typename FieldType >

FieldDocument NeoFOAM::finiteVolume::cellCentred::CreateFromExistingField< FieldType >::operator() ( Database &  db )

inline

Definition at line 375 of file fieldCollection.hpp.

Member Data Documentation

field

template<typename FieldType >

const FieldType& NeoFOAM::finiteVolume::cellCentred::CreateFromExistingField< FieldType >::field

Definition at line 370 of file fieldCollection.hpp.

iterationIndex

template<typename FieldType >

std::int64_t NeoFOAM::finiteVolume::cellCentred::CreateFromExistingField< FieldType >::iterationIndex = std::numeric_limits<std::int64_t>::max()

Definition at line 372 of file fieldCollection.hpp.

name

template<typename FieldType >

std::string NeoFOAM::finiteVolume::cellCentred::CreateFromExistingField< FieldType >::name

Definition at line 369 of file fieldCollection.hpp.

subCycleIndex

template<typename FieldType >

std::int64_t NeoFOAM::finiteVolume::cellCentred::CreateFromExistingField< FieldType >::subCycleIndex = std::numeric_limits<std::int64_t>::max()

Definition at line 373 of file fieldCollection.hpp.

timeIndex

template<typename FieldType >

std::int64_t NeoFOAM::finiteVolume::cellCentred::CreateFromExistingField< FieldType >::timeIndex = std::numeric_limits<std::int64_t>::max()

Definition at line 371 of file fieldCollection.hpp.

---

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

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