SpECTRE  v2026.06.30
Loading...
Searching...
No Matches
ylm::InitialShapes::FromFile< Frame > Class Template Reference

An initial Strahlkorper shape read from an H5 file. More...

#include <InitialShapeFromFile.hpp>

Classes

struct  CheckFrame
struct  H5Filename
struct  SubfileName
struct  Time
struct  TimeEpsilon

Public Types

using options

Public Member Functions

 FromFile (std::string h5_filename, std::string subfile_name, double time, double time_epsilon, bool check_frame)
Strahlkorper< Frame > strahlkorper (size_t l_max, const Options::Context &context) const override
 Construct a Strahlkorper with both l_max and m_max set to l_max. The context is used to report option-parsing errors.
void pup (PUP::er &p) override
Public Member Functions inherited from ylm::InitialShape< Frame >
 InitialShape (CkMigrateMessage *msg)
 WRAPPED_PUPable_abstract (InitialShape)

Static Public Member Functions

static std::string name ()

Static Public Attributes

static constexpr Options::String help

Detailed Description

template<typename Frame>
class ylm::InitialShapes::FromFile< Frame >

An initial Strahlkorper shape read from an H5 file.

Member Typedef Documentation

◆ options

template<typename Frame>
using ylm::InitialShapes::FromFile< Frame >::options
Initial value:
tmpl::list<H5Filename, SubfileName, Time, TimeEpsilon, CheckFrame>

Member Function Documentation

◆ strahlkorper()

template<typename Frame>
Strahlkorper< Frame > ylm::InitialShapes::FromFile< Frame >::strahlkorper ( size_t l_max,
const Options::Context & context ) const
overridevirtual

Construct a Strahlkorper with both l_max and m_max set to l_max. The context is used to report option-parsing errors.

Implements ylm::InitialShape< Frame >.

Member Data Documentation

◆ help

template<typename Frame>
Options::String ylm::InitialShapes::FromFile< Frame >::help
staticconstexpr
Initial value:
= {
"Construct a Strahlkorper from coefficients read from an H5 file."}

The documentation for this class was generated from the following file:
  • src/NumericalAlgorithms/Strahlkorper/IO/InitialShapeFromFile.hpp