SpECTRE  v2024.04.12
ForceFree::Tags::NsInteriorMask Struct Reference

An optional scalar variable used for masking the interior of neutron star(s) when running neutron star magnetosphere simulations. More...

#include <Tags.hpp>

Public Types

using type = std::optional< Scalar< DataVector > >
 

Detailed Description

An optional scalar variable used for masking the interior of neutron star(s) when running neutron star magnetosphere simulations.

For elements that contain any grid points inside the NS, we assign the value +1.0 to the grid points located outside the NS and assign -1.0 if located inside the NS.

For elements that do not contain any grid points inside the NS, this tag is not initialized and has null value i.e. has_value() == false.


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