SERiF v0.0.1a
Stellar Evolution and Rotation in Four Dimensions
Loading...
Searching...
No Matches
serif::model::SpecificationDefinition< Owner, Name, Role, Kind, Scalar, ReadFields, ChangedEquations > Struct Template Reference

Declare a prescription once; numerical providers and normalization consume this metadata. More...

#include <specification.hpp>

Collaboration diagram for serif::model::SpecificationDefinition< Owner, Name, Role, Kind, Scalar, ReadFields, ChangedEquations >:
[legend]

Public Types

using SpecificationType = Owner
 
using ScalarDescription = Scalar
 
using DependsOn = ReadFields
 
using Affects = ChangedEquations
 

Static Public Attributes

static constexpr std::string_view name {Name.data(), Name.size()}
 
static constexpr SpecificationRole role = Role
 
static constexpr GeneratedStateKind generated_state_kind = Kind
 

Detailed Description

template<typename Owner, utils::types::FixedString Name, SpecificationRole Role, GeneratedStateKind Kind = GeneratedStateKind::none, typename Scalar = void, typename ReadFields = Reads<>, typename ChangedEquations = Changes<>>
struct serif::model::SpecificationDefinition< Owner, Name, Role, Kind, Scalar, ReadFields, ChangedEquations >

Declare a prescription once; numerical providers and normalization consume this metadata.

Member Typedef Documentation

◆ Affects

template<typename Owner, utils::types::FixedString Name, SpecificationRole Role, GeneratedStateKind Kind = GeneratedStateKind::none, typename Scalar = void, typename ReadFields = Reads<>, typename ChangedEquations = Changes<>>
using serif::model::SpecificationDefinition< Owner, Name, Role, Kind, Scalar, ReadFields, ChangedEquations >::Affects = ChangedEquations

◆ DependsOn

template<typename Owner, utils::types::FixedString Name, SpecificationRole Role, GeneratedStateKind Kind = GeneratedStateKind::none, typename Scalar = void, typename ReadFields = Reads<>, typename ChangedEquations = Changes<>>
using serif::model::SpecificationDefinition< Owner, Name, Role, Kind, Scalar, ReadFields, ChangedEquations >::DependsOn = ReadFields

◆ ScalarDescription

template<typename Owner, utils::types::FixedString Name, SpecificationRole Role, GeneratedStateKind Kind = GeneratedStateKind::none, typename Scalar = void, typename ReadFields = Reads<>, typename ChangedEquations = Changes<>>
using serif::model::SpecificationDefinition< Owner, Name, Role, Kind, Scalar, ReadFields, ChangedEquations >::ScalarDescription = Scalar

◆ SpecificationType

template<typename Owner, utils::types::FixedString Name, SpecificationRole Role, GeneratedStateKind Kind = GeneratedStateKind::none, typename Scalar = void, typename ReadFields = Reads<>, typename ChangedEquations = Changes<>>
using serif::model::SpecificationDefinition< Owner, Name, Role, Kind, Scalar, ReadFields, ChangedEquations >::SpecificationType = Owner

Member Data Documentation

◆ generated_state_kind

template<typename Owner, utils::types::FixedString Name, SpecificationRole Role, GeneratedStateKind Kind = GeneratedStateKind::none, typename Scalar = void, typename ReadFields = Reads<>, typename ChangedEquations = Changes<>>
GeneratedStateKind serif::model::SpecificationDefinition< Owner, Name, Role, Kind, Scalar, ReadFields, ChangedEquations >::generated_state_kind = Kind
staticconstexpr

◆ name

template<typename Owner, utils::types::FixedString Name, SpecificationRole Role, GeneratedStateKind Kind = GeneratedStateKind::none, typename Scalar = void, typename ReadFields = Reads<>, typename ChangedEquations = Changes<>>
std::string_view serif::model::SpecificationDefinition< Owner, Name, Role, Kind, Scalar, ReadFields, ChangedEquations >::name {Name.data(), Name.size()}
staticconstexpr

◆ role

template<typename Owner, utils::types::FixedString Name, SpecificationRole Role, GeneratedStateKind Kind = GeneratedStateKind::none, typename Scalar = void, typename ReadFields = Reads<>, typename ChangedEquations = Changes<>>
SpecificationRole serif::model::SpecificationDefinition< Owner, Name, Role, Kind, Scalar, ReadFields, ChangedEquations >::role = Role
staticconstexpr

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