Public Types | Static Public Member Functions | Static Public Attributes | List of all members
domain::creators::time_dependence::TimeDependenceCompositionTag< TimeDep, Suffix > Struct Template Reference

A tag used by the Composition class to generate a TimeDependence that is a composition of existing TimeDependences. More...

#include <Composition.hpp>

Public Types

using type = std::unique_ptr< TimeDependence< TimeDep::mesh_dim > >
 
using time_dependence = TimeDep
 

Static Public Member Functions

static std::string name () noexcept
 

Static Public Attributes

static constexpr size_t mesh_dim = TimeDep::mesh_dim
 
static constexpr Options::String help
 

Detailed Description

template<typename TimeDep, size_t Suffix = std::numeric_limits<size_t>::max()>
struct domain::creators::time_dependence::TimeDependenceCompositionTag< TimeDep, Suffix >

A tag used by the Composition class to generate a TimeDependence that is a composition of existing TimeDependences.

The first template parameter is the existing TimeDependence while the Suffix parameter can be used by a composition that contains multiple of the same TimeDependence. This could occur for example when adding a rotation TimeDependence before and after a Translation since the two rotations would be rotating about a different center.

Member Data Documentation

◆ help

template<typename TimeDep , size_t Suffix = std::numeric_limits<size_t>::max()>
constexpr Options::String domain::creators::time_dependence::TimeDependenceCompositionTag< TimeDep, Suffix >::help
staticconstexpr
Initial value:
= {
"One of the maps in the composition."}

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