elliptic::Actions::InitializeBackgroundFields< System, BackgroundTag > Struct Template Reference

Initialize the variable-independent background fields for an elliptic solve. More...

#include <InitializeBackgroundFields.hpp>

Public Types
using	simple_tags = implementation defined
using	compute_tags = implementation defined

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

Detailed Description

template<typename System, typename BackgroundTag>
struct elliptic::Actions::InitializeBackgroundFields< System, BackgroundTag >

Initialize the variable-independent background fields for an elliptic solve.

Examples for background fields would be a background metric, associated curvature quantities, or matter sources such as a mass-density in the XCTS equations.

This action retrieves the System::background_fields from the BackgroundTag. It invokes the variables function with the inertial coordinates, the element's Mesh and the element's inverse Jacobian. These arguments allow computing numeric derivatives, if necessary.

Uses:

• System:
  • background_fields
• DataBox:
  • BackgroundTag
  • domain::Tags::Coordinates<Dim, Frame::Inertial>

DataBox:

• Adds:
  • Tags::Variables<background_fields>

---

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

• src/Elliptic/Actions/InitializeBackgroundFields.hpp