SpECTRE  v2026.04.01
Loading...
Searching...
No Matches
ForceFree::MaskNeutronStarInterior< Metavariables, UsedForFdGrid > Struct Template Reference

Assign the masking scalar variable (see Tags::NsInteriorMask) at the initialization phase in NS magnetosphere simulations. More...

#include <MaskNeutronStarInterior.hpp>

Public Types

using argument_tags
using return_tags

Static Public Member Functions

static void apply (const gsl::not_null< std::optional< Scalar< DataVector > > * > neutron_star_interior_mask, const tnsr::I< DataVector, 3, Frame::Inertial > &inertial_coords, const evolution::initial_data::InitialData &solution_or_data)

Detailed Description

template<typename Metavariables, bool UsedForFdGrid>
struct ForceFree::MaskNeutronStarInterior< Metavariables, UsedForFdGrid >

Assign the masking scalar variable (see Tags::NsInteriorMask) at the initialization phase in NS magnetosphere simulations.

Run the interior_mask() member function of the initial data if it is callable.

Member Typedef Documentation

◆ argument_tags

template<typename Metavariables, bool UsedForFdGrid>
using ForceFree::MaskNeutronStarInterior< Metavariables, UsedForFdGrid >::argument_tags
Initial value:
tmpl::list<
tmpl::conditional_t<
UsedForFdGrid,
The coordinates in a given frame.
Definition Tags.hpp:85
The coordinates in a given frame.
Definition Coordinates.hpp:39
The global cache tag for the initial data type.
Definition InitialData.hpp:37

◆ return_tags

template<typename Metavariables, bool UsedForFdGrid>
using ForceFree::MaskNeutronStarInterior< Metavariables, UsedForFdGrid >::return_tags
Initial value:
tmpl::list<tmpl::conditional_t<
UsedForFdGrid,
An optional scalar variable used for masking the interior of neutron star(s) when running neutron sta...
Definition Tags.hpp:132
Mark a tag as holding data for the inactive grid.
Definition Inactive.hpp:23

The documentation for this struct was generated from the following file:
  • src/Evolution/Systems/ForceFree/MaskNeutronStarInterior.hpp