specfem::runtime_configuration::seismogram

class seismogram

Seismogram class is used to instantiate seismogram writer.

Public Functions

inline seismogram(const std::string &output_format, const std::string &output_folder)

Construct a new seismogram object.

Parameters:

  • output_format – Outpul seismogram file format

  • output_folder – Path to folder location where seismogram will be stored

seismogram(const YAML::Node &Node)

Construct a new seismogram object.

Parameters:

Node – YAML node describing the seismogram writer

std::shared_ptr<specfem::io::writer> instantiate_seismogram_writer(const specfem::enums::elastic_wave wave_type, const specfem::enums::electromagnetic_wave electromagnetic_wave, const type_real dt, const type_real t0, const int nsteps_between_samples) const

Instantiate a seismogram writer object.

Parameters:

  • wave_type – Type of wavefield (Writes .BXY for SH waves and .BXX, .BXZ for P-SV waves)

  • dt – Time interval between subsequent timesteps

  • t0 – Solver start time

  • nsteps_between_samples – number of timesteps between seismogram sampling (seismogram sampling frequency)

Returns:

std::shared_ptr<specfem::io::writer> Pointer to an instantiated writer object

Private Members

std::string output_format

format of output file

std::string output_folder

Path to output folder.