SpECTRE  v2024.04.12
Public Types | Static Public Member Functions | List of all members
VariableFixing::Actions::FixVariables< VariableFixer > Struct Template Reference
Actions | Variable Fixing

Adjust variables with a variable fixer. More...

#include <Actions.hpp>

Public Types

using const_global_cache_tags = tmpl::list< Tags::VariableFixer< VariableFixer > >
 

Static Public Member Functions

template<typename DbTagsList , typename... InboxTags, typename Metavariables , typename ArrayIndex , typename ActionList , typename ParallelComponent , Requires< tmpl::size< DbTagsList >::value !=0 > = nullptr>
static Parallel::iterable_action_return_t apply (db::DataBox< DbTagsList > &box, tuples::TaggedTuple< InboxTags... > &, const Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &, const ActionList, const ParallelComponent *const)
 

Detailed Description

template<typename VariableFixer>
struct VariableFixing::Actions::FixVariables< VariableFixer >

Adjust variables with a variable fixer.

Typically this action is called to adjust either conservative or primitive variables when they violate physical constraints. See the individual variable fixers in the VariableFixing namespace for more details.

Uses:

  • DataBox:
    • Metavariables::variable_fixer::argument_tags
  • GlobalCache:
    • Metavariables::variable_fixer

DataBox changes:

  • Adds: nothing
  • Removes: nothing
  • Modifies: Metavariables::variable_fixer::return_tags
The documentation for this struct was generated from the following file: