shamrock::patch::FieldDescriptor< T > Class Template Reference

Structure describing a field in a patch data layout. More...

#include <shamrock/include/shamrock/patch/PatchDataLayerLayout.hpp>

Collaboration diagram for shamrock::patch::FieldDescriptor< T >:

Public Types
using	field_T = T
	The type of the field mirrored from the template type.

Public Member Functions
	FieldDescriptor ()
	Default constructor.
	FieldDescriptor (std::string name, u32 nvar)
	Constructor with a given name and number of variables.

Public Attributes
std::string	name
	The name of the field.
u32	nvar
	The number of variables of the field per object.

Detailed Description

template<class T>
class shamrock::patch::FieldDescriptor< T >

Structure describing a field in a patch data layout.

The field descriptor contains the name of the field and the number of variables of the field.

Definition at line 38 of file PatchDataLayerLayout.hpp.

Member Typedef Documentation

field_T

template<class T >

using shamrock::patch::FieldDescriptor< T >::field_T = T

The type of the field mirrored from the template type.

Definition at line 41 of file PatchDataLayerLayout.hpp.

Constructor & Destructor Documentation

FieldDescriptor() [1/2]

template<class T >

shamrock::patch::FieldDescriptor< T >::FieldDescriptor ( )

inline

Default constructor.

The default constructor initializes the field descriptor with an empty name and 1 variable.

Definition at line 55 of file PatchDataLayerLayout.hpp.

FieldDescriptor() [2/2]

template<class T >

shamrock::patch::FieldDescriptor< T >::FieldDescriptor ( std::string  name, u32  nvar  )

inline

Constructor with a given name and number of variables.

Parameters

name	The name of the field.
nvar	The number of variables of the field.

Definition at line 63 of file PatchDataLayerLayout.hpp.

Member Data Documentation

name

template<class T >

std::string shamrock::patch::FieldDescriptor< T >::name

The name of the field.

Definition at line 44 of file PatchDataLayerLayout.hpp.

nvar

template<class T >

u32 shamrock::patch::FieldDescriptor< T >::nvar

The number of variables of the field per object.

Definition at line 47 of file PatchDataLayerLayout.hpp.

---

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

• shamrock/include/shamrock/patch/PatchDataLayerLayout.hpp