Initialization::Actions::InitializeItems< Mutators > Struct Template Reference

Mutate DataBox items by calling db::mutate_apply on each Mutator in the order they are specified. More...

#include <InitializeItems.hpp>

Public Types
using	const_global_cache_tags
	Tags for constant items added to the GlobalCache. These items are initialized from input file options.
using	mutable_global_cache_tags
	Tags for mutable items added to the GlobalCache. These items are initialized from input file options.
using	simple_tags_from_options
	Tags for simple DataBox items that are initialized from input file options.
using	simple_tags
	Tags for simple DataBox items that are default initialized. They may be mutated by the Mutators.
using	compute_tags
	Tags for immutable DataBox items (compute items or reference items).

Static Public Member Functions
template<typename DbTagsList, typename... InboxTags, typename Metavariables, typename ArrayIndex, typename ActionList, typename ParallelComponent>
static Parallel::iterable_action_return_t	apply (db::DataBox< DbTagsList > &box, const tuples::TaggedTuple< InboxTags... > &, const Parallel::GlobalCache< Metavariables > &, const ArrayIndex &, ActionList, const ParallelComponent *const)

Detailed Description

template<typename... Mutators>
struct Initialization::Actions::InitializeItems< Mutators >

Mutate DataBox items by calling db::mutate_apply on each Mutator in the order they are specified.

There's a specialization for InitializeItems<tmpl::list<Mutators...>> that can also be used if a tmpl::list is available.

Details

In addition to the requirements specified by db::mutate_apply, each Mutator must define the type aliases of this action.

Member Typedef Documentation

compute_tags

template<typename... Mutators>

using Initialization::Actions::InitializeItems< Mutators >::compute_tags

Initial value:

 tmpl::remove_duplicates<
      tmpl::flatten<tmpl::append<typename Mutators::compute_tags...>>>

Tags for immutable DataBox items (compute items or reference items).

const_global_cache_tags

template<typename... Mutators>

using Initialization::Actions::InitializeItems< Mutators >::const_global_cache_tags

Initial value:

 tmpl::remove_duplicates<tmpl::flatten<
      tmpl::append<typename Mutators::const_global_cache_tags...>>>

Tags for constant items added to the GlobalCache. These items are initialized from input file options.

mutable_global_cache_tags

template<typename... Mutators>

using Initialization::Actions::InitializeItems< Mutators >::mutable_global_cache_tags

Initial value:

 tmpl::remove_duplicates<tmpl::flatten<
      tmpl::append<typename Mutators::mutable_global_cache_tags...>>>

Tags for mutable items added to the GlobalCache. These items are initialized from input file options.

simple_tags

template<typename... Mutators>

using Initialization::Actions::InitializeItems< Mutators >::simple_tags

Initial value:

 tmpl::remove_duplicates<
      tmpl::flatten<tmpl::append<typename Mutators::simple_tags...>>>

Tags for simple DataBox items that are default initialized. They may be mutated by the Mutators.

simple_tags_from_options

template<typename... Mutators>

using Initialization::Actions::InitializeItems< Mutators >::simple_tags_from_options

Initial value:

 tmpl::remove_duplicates<tmpl::flatten<
      tmpl::append<typename Mutators::simple_tags_from_options...>>>

Tags for simple DataBox items that are initialized from input file options.

---

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

• src/ParallelAlgorithms/Actions/InitializeItems.hpp