Class emulator::DerivedDiagnostic

ClassList > emulator > DerivedDiagnostic

Base class for derived diagnostics. More...

• #include <derived_diagnostic.hpp>

Inherited by the following classes: emulator::HorizAvgDiagnostic, emulator::VertSliceDiagnostic

Public Functions

Type	Name
virtual void	compute (const FieldDataProvider & fields, std::vector< double > & output) = 0 Compute the diagnostic.
virtual std::string	name () const = 0 Get the diagnostic name.
virtual int	output_size (int ncols, int nlevs) const = 0 Get output size.
virtual std::string	source_field () const = 0 Get the source field name.
virtual	~DerivedDiagnostic () = default

Detailed Description

Public Functions Documentation

function compute

Compute the diagnostic.

virtual void emulator::DerivedDiagnostic::compute (
    const FieldDataProvider & fields,
    std::vector< double > & output
) = 0

Parameters:

• fields Input field provider
• output Output data buffer (caller must allocate)

---

function name

Get the diagnostic name.

virtual std::string emulator::DerivedDiagnostic::name () const = 0

---

function output_size

Get output size.

virtual int emulator::DerivedDiagnostic::output_size (
    int ncols,
    int nlevs
) const = 0

Parameters:

• ncols Number of local columns
• nlevs Number of vertical levels (for source field)

---

function source_field

Get the source field name.

virtual std::string emulator::DerivedDiagnostic::source_field () const = 0

---

function ~DerivedDiagnostic

virtual emulator::DerivedDiagnostic::~DerivedDiagnostic () = default

---

---

The documentation for this class was generated from the following file components/emulator_comps/common/src/diagnostics/derived_diagnostic.hpp