OpenLB 1.7
Loading...
Searching...
No Matches
Public Types | Static Public Member Functions | List of all members
olb::descriptors::TYPED_FIELD_BASE< TYPE, C, U > Struct Template Reference

Base of a descriptor field of scalar TYPE with dimensions A*B + B*Q + C. More...

#include <descriptorField.h>

+ Inheritance diagram for olb::descriptors::TYPED_FIELD_BASE< TYPE, C, U >:
+ Collaboration diagram for olb::descriptors::TYPED_FIELD_BASE< TYPE, C, U >:

Public Types

template<typename T >
using value_type = std::conditional_t<std::is_same_v<T,Expr>,Expr,TYPE>
 
template<typename T >
using column_type = AbstractColumn<TYPE>
 
- Public Types inherited from olb::descriptors::FIELD_BASE< C, U... >
using value_type
 Return value type of field.
 
using column_type
 

Static Public Member Functions

template<typename T , typename DESCRIPTOR >
static constexpr auto getInitialValue ()
 
static constexpr bool isSerializable ()
 
- Static Public Member Functions inherited from olb::descriptors::FIELD_BASE< C, U... >
static constexpr std::size_t size (std::index_sequence< V... >)
 Get size of field for parameter vector V (strict)
 
static constexpr std::size_t size ()
 Get size of field for parameter vector V (zero-padds or shortens V as required)
 
static constexpr auto getInitialValue ()
 Return value must be a correctly sized and typed olb::Vector.
 
static constexpr bool isSerializable ()
 

Additional Inherited Members

- Public Member Functions inherited from olb::descriptors::FIELD_BASE< C, U... >
 FIELD_BASE ()=default
 

Detailed Description

template<typename TYPE, unsigned C, unsigned... U>
struct olb::descriptors::TYPED_FIELD_BASE< TYPE, C, U >

Base of a descriptor field of scalar TYPE with dimensions A*B + B*Q + C.

Definition at line 106 of file descriptorField.h.

Member Typedef Documentation

◆ column_type

template<typename TYPE , unsigned C, unsigned... U>
template<typename T >
using olb::descriptors::TYPED_FIELD_BASE< TYPE, C, U >::column_type = AbstractColumn<TYPE>

Definition at line 111 of file descriptorField.h.

◆ value_type

template<typename TYPE , unsigned C, unsigned... U>
template<typename T >
using olb::descriptors::TYPED_FIELD_BASE< TYPE, C, U >::value_type = std::conditional_t<std::is_same_v<T,Expr>,Expr,TYPE>

Definition at line 108 of file descriptorField.h.

Member Function Documentation

◆ getInitialValue()

template<typename TYPE , unsigned C, unsigned... U>
template<typename T , typename DESCRIPTOR >
static constexpr auto olb::descriptors::TYPED_FIELD_BASE< TYPE, C, U >::getInitialValue ( )
inlinestaticconstexpr

Definition at line 114 of file descriptorField.h.

114 {
115 return Vector<value_type<T>, DESCRIPTOR::template size<FIELD_BASE<C,U...>>()>{};
116 }
static constexpr std::size_t size()
Get size of field for parameter vector V (zero-padds or shortens V as required)

References olb::descriptors::FIELD_BASE< C, U... >::size().

+ Here is the call graph for this function:

◆ isSerializable()

template<typename TYPE , unsigned C, unsigned... U>
static constexpr bool olb::descriptors::TYPED_FIELD_BASE< TYPE, C, U >::isSerializable ( )
inlinestaticconstexpr

Definition at line 118 of file descriptorField.h.

118 {
119 return !std::is_pointer_v<TYPE>;
120 }

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