ARTS 2.5.11 (git: 6827797f)
GriddedField3 Class Referencefinal

#include <gridded_fields.h>

Inheritance diagram for GriddedField3:

Public Member Functions

 GriddedField3 ()
 Construct an empty GriddedField3.
 GriddedField3 (const String &s)
 Construct an empty GriddedField3 with the given name.
GriddedField3operator= (Numeric n)
bool checksize () const final
 Consistency check.
void checksize_strict () const final
 Strict consistency check.
void resize (const GriddedField3 &gf)
 Make this GriddedField3 the same size as the given one.
void resize (Index p, Index r, Index c)
 Resize the data tensor.
- Public Member Functions inherited from GriddedField
virtual ~GriddedField ()=default
 Defaulted con-/de-structors and assignments so unique pointers work w/o warnings.
 GriddedField (const GriddedField &)=default
 GriddedField (GriddedField &&)=default
GriddedFieldoperator= (const GriddedField &)=default
GriddedFieldoperator= (GriddedField &&)=default
Index get_dim () const
 Get the dimension of this gridded field.
void copy_grids (const GriddedField &gf)
 Copy grids.
const Stringget_grid_name (Index i) const
 Get grid name.
Index get_grid_size (Index i) const
 Get the size of a grid.
GridType get_grid_type (Index i) const
 Get grid type.
const Vector & get_numeric_grid (Index i) const
 Get a numeric grid.
Vector & get_numeric_grid (Index i)
 Get a numeric grid.
const ArrayOfStringget_string_grid (Index i) const
 Get a string grid.
ArrayOfStringget_string_grid (Index i)
 Get a string grid.
const Stringget_name () const
 Get the name of this gridded field.
void set_grid (Index i, const Vector &g)
 Set a numeric grid.
void set_grid (Index i, const ArrayOfString &g)
 Set a string grid.
void set_grid_name (Index i, const String &s)
 Set grid name.
void set_name (const String &s)
 Set name of this gridded field.
virtual bool checksize () const =0
 Consistency check.
virtual void checksize_strict () const =0
 Strict consistency check.

Public Attributes

Tensor3 data


std::ostream & operator<< (std::ostream &os, const GriddedField3 &gf)
String metaErrorData (const GriddedField3 &gf)

Additional Inherited Members

- Protected Member Functions inherited from GriddedField
 GriddedField ()
 Construct an empty GriddedField.
 GriddedField (const Index d, String s)
 Construct a GriddedField.

Detailed Description

Definition at line 356 of file gridded_fields.h.

Constructor & Destructor Documentation

◆ GriddedField3() [1/2]

GriddedField3::GriddedField3 ( )

Construct an empty GriddedField3.

Definition at line 359 of file gridded_fields.h.

◆ GriddedField3() [2/2]

GriddedField3::GriddedField3 ( const String s)

Construct an empty GriddedField3 with the given name.


Definition at line 362 of file gridded_fields.h.

Member Function Documentation

◆ checksize()

bool GriddedField3::checksize ( ) const

Consistency check.

Check if the sizes of the grids match the data dimension.

This function must be overwritten by the derived classes.

True if sizes match.

Implements GriddedField.

Definition at line 370 of file gridded_fields.h.

References data, and GriddedField::get_grid_size().

Referenced by atm_fields_compactAddSpecies(), atm_fields_compactCreateFromField(), and checksize_strict().

◆ checksize_strict()

void GriddedField3::checksize_strict ( ) const

Strict consistency check.

Same as GriddedField::checksize but throws runtime_error in case of error.

Implements GriddedField.

Definition at line 379 of file gridded_fields.h.

References ARTS_USER_ERROR_IF, and checksize().

Referenced by complex_n_interp(), and xml_read_from_stream().

◆ operator=()

GriddedField3 & GriddedField3::operator= ( Numeric  n)

Definition at line 364 of file gridded_fields.h.

References data.

◆ resize() [1/2]

◆ resize() [2/2]

void GriddedField3::resize ( Index  p,
Index  r,
Index  c 

Resize the data tensor.

See also

Definition at line 391 of file gridded_fields.h.

References c, and data.

Friends And Related Function Documentation

◆ metaErrorData

String metaErrorData ( const GriddedField3 gf)

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
const GriddedField3 gf 

Member Data Documentation

◆ data

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