Skip to content

Class emulator::FieldDataProvider

ClassList > emulator > FieldDataProvider

Interface for providing field data to output streams. More...

  • #include <emulator_output_stream.hpp>

Inherited by the following classes: emulator::impl::AtmFieldDataProvider

Public Functions

Type Name
virtual const std::vector< double > * get_field (const std::string & name) const = 0
Get pointer to field data by name.
virtual std::vector< std::string > get_field_names () const = 0
Get list of all available field names.
virtual int get_field_nlevs (const std::string & name) const
Check if a field has vertical levels (is 3D).
virtual int get_ncols () const = 0
Get number of local columns.
virtual ~FieldDataProvider () = default

Detailed Description

Components implement this to provide access to their field data.

Public Functions Documentation

function get_field

Get pointer to field data by name.

virtual const std::vector< double > * emulator::FieldDataProvider::get_field (
    const std::string & name
) const = 0

Parameters:

  • name Field name

Returns:

Pointer to data vector, or nullptr if not found


function get_field_names

Get list of all available field names.

virtual std::vector< std::string > emulator::FieldDataProvider::get_field_names () const = 0


function get_field_nlevs

Check if a field has vertical levels (is 3D).

inline virtual int emulator::FieldDataProvider::get_field_nlevs (
    const std::string & name
) const

Returns:

Number of levels, or 1 for 2D fields


function get_ncols

Get number of local columns.

virtual int emulator::FieldDataProvider::get_ncols () const = 0


function ~FieldDataProvider

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


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