ARTS  2.2.66
GriddedField5 Class Reference

#include <gridded_fields.h>

Inheritance diagram for GriddedField5:
Collaboration diagram for GriddedField5:

Public Member Functions

 GriddedField5 ()
 Construct an empty GriddedField5. More...
 
 GriddedField5 (const String &s)
 Construct an empty GriddedField5 with the given name. More...
 
virtual bool checksize () const
 Consistency check. More...
 
virtual void checksize_strict () const
 Strict consistency check. More...
 
void resize (const GriddedField5 &gf)
 Make this GriddedField5 the same size as the given one. More...
 
void resize (Index s, Index b, Index p, Index r, Index c)
 Resize the data tensor. More...
 
- Public Member Functions inherited from GriddedField
Index get_dim () const
 Get the dimension of this gridded field. More...
 
void copy_grids (const GriddedField &gf)
 Copy grids. More...
 
const Stringget_grid_name (Index i) const
 Get grid name. More...
 
Index get_grid_size (Index i) const
 Get the size of a grid. More...
 
GridType get_grid_type (Index i) const
 Get grid type. More...
 
ConstVectorView get_numeric_grid (Index i) const
 Get a numeric grid. More...
 
VectorView get_numeric_grid (Index i)
 Get a numeric grid. More...
 
const ArrayOfStringget_string_grid (Index i) const
 Get a string grid. More...
 
ArrayOfStringget_string_grid (Index i)
 Get a string grid. More...
 
const Stringget_name () const
 Get the name of this gridded field. More...
 
void set_grid (Index i, const Vector &g)
 Set a numeric grid. More...
 
void set_grid (Index i, const ArrayOfString &g)
 Set a string grid. More...
 
void set_grid_name (Index i, const String &s)
 Set grid name. More...
 
void set_name (const String &s)
 Set name of this gridded field. More...
 
virtual ~GriddedField ()
 GriddedField virtual destructor. More...
 

Public Attributes

Tensor5 data
 

Friends

std::ostream & operator<< (std::ostream &os, const GriddedField5 &gf)
 

Additional Inherited Members

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

Detailed Description

Definition at line 438 of file gridded_fields.h.

Constructor & Destructor Documentation

◆ GriddedField5() [1/2]

GriddedField5::GriddedField5 ( )
inline

Construct an empty GriddedField5.

Definition at line 441 of file gridded_fields.h.

◆ GriddedField5() [2/2]

GriddedField5::GriddedField5 ( const String s)
inline

Construct an empty GriddedField5 with the given name.

Parameters
[in]sName.

Definition at line 444 of file gridded_fields.h.

Member Function Documentation

◆ checksize()

virtual bool GriddedField5::checksize ( ) const
inlinevirtual

Consistency check.

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

This function must be overwritten by the derived classes.

Returns
True if sizes match.

Implements GriddedField.

Definition at line 446 of file gridded_fields.h.

References GriddedField::get_grid_size().

◆ checksize_strict()

virtual void GriddedField5::checksize_strict ( ) const
inlinevirtual

Strict consistency check.

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

Implements GriddedField.

Definition at line 460 of file gridded_fields.h.

References CHECK_ERROR_BOILERPLATE, GriddedField::checksize(), GriddedField::get_grid_name(), GriddedField::get_grid_size(), and GriddedField::get_name().

Referenced by surface_complex_refr_indexFromGriddedField5().

◆ resize() [1/2]

void GriddedField5::resize ( const GriddedField5 gf)
inline

Make this GriddedField5 the same size as the given one.

Parameters
[in]gfSource gridded field.

Definition at line 483 of file gridded_fields.h.

References GriddedField::get_grid_size().

◆ resize() [2/2]

void GriddedField5::resize ( Index  s,
Index  b,
Index  p,
Index  r,
Index  c 
)
inline

Resize the data tensor.

See also
Tensor5::resize

Definition at line 494 of file gridded_fields.h.

References GriddedField::operator<<.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const GriddedField5 gf 
)
friend

Member Data Documentation

◆ data

Tensor5 GriddedField5::data

Definition at line 501 of file gridded_fields.h.

Referenced by surface_complex_refr_indexFromGriddedField5().


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