#include "agenda_class.h"
#include "exceptions.h"
#include "matpackVII.h"
#include "mystring.h"
#include "gridded_fields.h"

Functions
void	chk_if_bool (const String &x_name, const Index &x)
	chk_if_bool More...

void	chk_if_in_range (const String &x_name, const Index &x, const Index &x_low, const Index &x_high)
	chk_if_in_range More...

void	chk_if_increasing (const String &x_name, const ArrayOfIndex &x)
	chk_if_increasing More...

void	chk_not_negative (const String &x_name, const Numeric &x)
	chk_not_negative More...

void	chk_if_in_range (const String &x_name, const Numeric &x, const Numeric &x_low, const Numeric &x_high)
	chk_if_in_range More...

void	chk_vector_length (const String &x_name, ConstVectorView x, const Index &l)
	chk_vector_length More...

void	chk_vector_length (const String &x1_name, const String &x2_name, ConstVectorView x1, ConstVectorView x2)
	chk_vector_length More...

void	chk_if_increasing (const String &x_name, ConstVectorView x)
	chk_if_increasing More...

void	chk_if_decreasing (const String &x_name, ConstVectorView x)
	chk_if_decreasing More...

void	chk_if_equal (const String &x1_name, const String &x2_name, ConstVectorView v1, ConstVectorView v2, Numeric margin=1e-6)
	chk_if_equal More...

void	chk_interpolation_grids (const String &which_interpolation, ConstVectorView old_grid, ConstVectorView new_grid, const Index order=1, const Numeric &extpolfac=0.5)
	Check interpolation grids. More...

void	chk_interpolation_grids (const String &which_interpolation, ConstVectorView old_grid, const Numeric &new_grid, const Index order=1, const Numeric &extpolfac=0.5)
	Check interpolation grids. More...

void	chk_matrix_ncols (const String &x_name, ConstMatrixView x, const Index &l)
	chk_matrix_ncols More...

void	chk_matrix_nrows (const String &x_name, ConstMatrixView x, const Index &l)
	chk_matrix_nrows More...

void	chk_atm_grids (const Index &dim, ConstVectorView p_grid, ConstVectorView lat_grid, ConstVectorView lon_grid)
	chk_atm_grids More...

void	chk_atm_field (const String &x_name, ConstTensor3View x, const Index &dim, ConstVectorView p_grid, ConstVectorView lat_grid, ConstVectorView lon_grid)
	chk_atm_field (simple fields) More...

void	chk_atm_field (const String &x_name, ConstTensor4View x, const Index &dim, const Index &nspecies, ConstVectorView p_grid, ConstVectorView lat_grid, ConstVectorView lon_grid)
	chk_atm_field (fields with one more dimension) More...

void	chk_atm_surface (const String &x_name, const Matrix &x, const Index &dim, ConstVectorView lat_grid, ConstVectorView lon_grid)
	chk_atm_surface More...

void	chk_not_empty (const String &x_name, const Agenda &x)
	chk_not_empty More...

void	chk_pnd_field_raw_only_in_cloudbox (const Index &dim, const ArrayOfGriddedField3 &pnd_field_raw, ConstVectorView p_grid, ConstVectorView lat_grid, ConstVectorView lon_grid, const ArrayOfIndex &cloudbox_limits)
	chk_pnd_field_raw_only_in_cloudbox More...

template<class T >
Index	chk_contains (const String &x_name, const Array< T > &x, const T &what)
	Check if an array contains a value. More...

template<class T >
void	chk_size (const String &x_name, const Array< T > &x, const Index &c)
	Check the size of an array. More...

void	chk_size (const String &x_name, ConstVectorView x, const Index &c)
	Runtime check for size of Vector. More...

void	chk_size (const String &x_name, ConstMatrixView x, const Index &r, const Index &c)
	Runtime check for size of Matrix. More...

void	chk_size (const String &x_name, ConstTensor3View x, const Index &p, const Index &r, const Index &c)
	Runtime check for size of Tensor. More...

void	chk_size (const String &x_name, ConstTensor4View x, const Index &b, const Index &p, const Index &r, const Index &c)
	Runtime check for size of Tensor. More...

void	chk_size (const String &x_name, ConstTensor5View x, const Index &s, const Index &b, const Index &p, const Index &r, const Index &c)
	Runtime check for size of Tensor. More...

void	chk_size (const String &x_name, ConstTensor6View x, const Index &v, const Index &s, const Index &b, const Index &p, const Index &r, const Index &c)
	Runtime check for size of Tensor. More...

void	chk_size (const String &x_name, ConstTensor7View x, const Index &l, const Index &v, const Index &s, const Index &b, const Index &p, const Index &r, const Index &c)
	Runtime check for size of Tensor. More...

Detailed Description

Author: Patrick Eriksson patri.nosp@m.ck.e.nosp@m.rikss.nosp@m.on@c.nosp@m.halme.nosp@m.rs.s.nosp@m.e

Date: 2002-04-15

This file contains the declaration of functions in check_input.cc.

Definition in file check_input.h.

Function Documentation

◆ chk_atm_field() [1/2]

void chk_atm_field	(	const String &	x_name,
		ConstTensor3View	x,
		const Index &	dim,
		ConstVectorView	p_grid,
		ConstVectorView	lat_grid,
		ConstVectorView	lon_grid
	)

chk_atm_field (simple fields)

Checks if an atmospheric field matches the dimensionality and the grids.

The function gives an error message if this is not the case.

Parameters

x_name	The name of the atmospheric field.
x	A variable holding an atmospheric field.
dim	The atmospheric dimensionality.
p_grid	The pressure grid.
lat_grid	The latitude grid.
lon_grid	The longitude grid.

Author: Patrick Eriksson

Date: 2002-04-15

Definition at line 683 of file check_input.cc.

References ConstTensor3View::ncols(), ConstVectorView::nelem(), ConstTensor3View::npages(), and ConstTensor3View::nrows().

Referenced by abs_fieldCalc(), abs_lookupSetup(), AtmFieldsExpand1D(), AtmFieldsRefinePgrid(), and basics_checkedCalc().

◆ chk_atm_field() [2/2]

void chk_atm_field	(	const String &	x_name,
		ConstTensor4View	x,
		const Index &	dim,
		const Index &	nspecies,
		ConstVectorView	p_grid,
		ConstVectorView	lat_grid,
		ConstVectorView	lon_grid
	)

chk_atm_field (fields with one more dimension)

Checks if an atmospheric field matches the dimensionality and the grids. This is the version for fields like vmr_field, which are a Tensor4, not a Tensor3. (First dimension is the gas species.)

The function gives an error message if this is not the case.

Parameters

x_name	The name of the atmospheric field.
x	A variable holding an atmospheric field.
dim	The atmospheric dimensionality.
nspecies	Number of species.
p_grid	The pressure grid.
lat_grid	The latitude grid.
lon_grid	The longitude grid.

Author: Stefan Buehler, cloned from Patrick Eriksson

Date: 2002-12-20

Definition at line 747 of file check_input.cc.

References ConstTensor4View::nbooks(), ConstTensor4View::ncols(), ConstVectorView::nelem(), ConstTensor4View::npages(), and ConstTensor4View::nrows().

◆ chk_atm_grids()

void chk_atm_grids	(	const Index &	dim,
		ConstVectorView	p_grid,
		ConstVectorView	lat_grid,
		ConstVectorView	lon_grid
	)

chk_atm_grids

Checks if the atmospheric grids and the specified atmospheric dimensionality match, and if the grids are ordered correctly.

The function gives an error message if this is not the case.

Parameters

dim	The atmospheric dimensionality.
p_grid	The pressure grid.
lat_grid	The latitude grid.
lon_grid	The longitude grid.

Author: Patrick Eriksson

Date: 2002-04-15

Definition at line 603 of file check_input.cc.

References chk_if_decreasing(), chk_if_increasing(), and ConstVectorView::nelem().

Referenced by abs_fieldCalc(), abs_lookupSetup(), AtmFieldsCalc(), AtmFieldsCalcExpand1D(), AtmFieldsExpand1D(), AtmFieldsFromCompact(), AtmFieldsFromCompactChevalAll(), AtmFieldsRefinePgrid(), basics_checkedCalc(), cloudboxSetAutomatically(), cloudboxSetManually(), doit_i_fieldSetConst(), doit_i_fieldUpdateSeq3D(), DoitCloudboxFieldPut(), ParticleTypeAdd(), ParticleTypeAddAll(), pnd_fieldCalc(), r_geoidSpherical(), and r_geoidWGS84().

◆ chk_atm_surface()

void chk_atm_surface	(	const String &	x_name,
		const Matrix &	x,
		const Index &	dim,
		ConstVectorView	lat_grid,
		ConstVectorView	lon_grid
	)

chk_atm_surface

Checks if a surface-type variable matches the dimensionality and the grids.

Examples of surface-type variables are z_surface and r_geoid.

The function gives an error message if this is not the case.

Parameters

x_name	The name of the surface-type variable.
x	The variable holding the surface data.
dim	The atmospheric dimensionality.
lat_grid	The latitude grid.
lon_grid	The longitude grid.

Author: Patrick Eriksson

Date: 2002-04-15

Definition at line 821 of file check_input.cc.

References ConstMatrixView::ncols(), ConstVectorView::nelem(), and ConstMatrixView::nrows().

Referenced by basics_checkedCalc(), doit_i_fieldUpdate1D(), doit_i_fieldUpdateSeq1D(), doit_i_fieldUpdateSeq3D(), and sensor_posAddRgeoid().

◆ chk_contains()

template<class T >

Index chk_contains	(	const String &	x_name,
		const Array< T > &	x,
		const T &	what
	)

Check if an array contains a value.

This makes sure that the array x contains the element with value what exactly once.

As a bonus, it returns the index of what in x.

This template function can be used for arrays of anything, provided that the "==" operator is defined.

Returns: The index of the thing we looked for.

Parameters

x_name	Name of the array to check
x	The array to check
what	The value to look for.

Author: Stefan Buehler

Date: 2002-11-28

Definition at line 193 of file check_input.h.

References find_all(), and Array< base >::nelem().

Referenced by GasAbsLookup::Adapt(), get_pointers_for_analytical_jacobians(), and jacobianCalcAbsSpeciesPerturbations().

◆ chk_if_bool()

void chk_if_bool	(	const String &	x_name,
		const Index &	x
	)

chk_if_bool

Checks that a variable of type Index has the value 0 or 1.

The function gives an error message if this is not the case.

Parameters

x_name	The name of the variable.
x	A variable of type Index.

Author: Patrick Eriksson

Date: 2002-04-15

Definition at line 67 of file check_input.cc.

References is_bool().

Referenced by cloudbox_checkedCalc(), sensor_responseAntenna(), and sensor_responseInit().

◆ chk_if_decreasing()

void chk_if_decreasing	(	const String &	x_name,
		ConstVectorView	x
	)

chk_if_decreasing

Checks if a vector is strictly decreasing.

Duplicated values are not allowed.

The function gives an error message if this is not the case.

Parameters

x_name	The name of the variable.
x	A variable of type Vector.

Author: Patrick Eriksson

Date: 2002-04-15

Definition at line 316 of file check_input.cc.

References is_decreasing().

Referenced by GasAbsLookup::Adapt(), chk_atm_grids(), doit_i_fieldUpdate1D(), and doit_i_fieldUpdateSeq1D().

◆ chk_if_equal()

void chk_if_equal	(	const String &	x1_name,
		const String &	x2_name,
		ConstVectorView	v1,
		ConstVectorView	v2,
		Numeric	margin
	)

chk_if_equal

Checks if two vectors are equal within a margin.

Parameters

x1_name	The name of the first variable (used in error message).
x2_name	The name of the second variable (used in error message).
v1	First vector
v2	Second vector
margin	uncertainty margin. Default: 1e-6

Author: Gerrit Holl

Date: 2011-05-04

Definition at line 343 of file check_input.cc.

References abs, chk_vector_length(), and ConstVectorView::nelem().

◆ chk_if_in_range() [1/2]

void chk_if_in_range	(	const String &	x_name,
		const Index &	x,
		const Index &	x_low,
		const Index &	x_high
	)

chk_if_in_range

Checks that a variable of type Index has a value inside the specified range.

The function gives an error message if this is not the case.

Parameters

x_name	The name of the variable.
x	A variable of type Index.
x_low	Lowest allowed value for x.
x_high	Highest allowed value for x.

Author: Patrick Eriksson

Date: 2002-04-15

Definition at line 95 of file check_input.cc.

Referenced by GasAbsLookup::Adapt(), AntennaMultiBeamsToPencilBeams(), AtmFieldsCalc(), AtmFieldsCalcExpand1D(), AtmFieldsExpand1D(), basics_checkedCalc(), cloudboxSetAutomatically(), cloudboxSetManually(), cloudboxSetManuallyAltitude(), complex_nWaterLiebe93(), doit_i_fieldSetConst(), doit_za_interpSet(), DoitCloudboxFieldPut(), DoitInit(), interp_gfield3(), InterpSurfaceEmissivityFieldIncLatLon(), ParticleTypeAdd(), ParticleTypeAddAll(), ppath_calc(), r_geoidSpherical(), r_geoidWGS84(), rte_losSet(), rte_posAddRgeoid(), rte_posSet(), sensor_posAddRgeoid(), sensor_responseAntenna(), sensor_responseInit(), surfaceBlackbody(), surfaceFlatReflectivity(), surfaceFlatRefractiveIndex(), surfaceFlatSingleEmissivity(), surfaceFlatVaryingEmissivity(), surfaceLambertianSimple(), yCalc(), and yCalc2().

◆ chk_if_in_range() [2/2]

void chk_if_in_range	(	const String &	x_name,
		const Numeric &	x,
		const Numeric &	x_low,
		const Numeric &	x_high
	)

chk_if_in_range

Checks that a variable of type Numeric has a value inside the specified range.

The function gives an error message if this is not the case.

Parameters

x_name	The name of the variable.
x	A variable of type Numeric.
x_low	Lowest allowed value for x.
x_high	Highest allowed value for x.

Author: Patrick Eriksson

Date: 2002-04-15

Definition at line 187 of file check_input.cc.

◆ chk_if_increasing() [1/2]

void chk_if_increasing	(	const String &	x_name,
		const ArrayOfIndex &	x
	)

chk_if_increasing

Checks if an ArrayOfIndex is strictly increasing. Cloned from Patricks similar function for Vector.

Duplicated values are not allowed.

The function gives an error message if this is not the case.

Parameters

x_name	The name of the variable.
x	A variable of type ArrayOfIndex.

Author: Stefan Buehler

Date: 2007-05-18

Definition at line 126 of file check_input.cc.

References is_increasing().

Referenced by GasAbsLookup::Adapt(), basics_checkedCalc(), chk_atm_grids(), doit_conv_flagAbsBT(), doit_conv_flagLsq(), doit_i_fieldUpdate1D(), doit_i_fieldUpdateSeq1D(), doit_i_fieldUpdateSeq3D(), interp_gfield3(), ParticleTypeAdd(), ParticleTypeAddAll(), ScatteringDoit(), sensor_responseAntenna(), sensor_responseInit(), WMRFSelectChannels(), yCalc(), and yCalc2().

◆ chk_if_increasing() [2/2]

void chk_if_increasing	(	const String &	x_name,
		ConstVectorView	x
	)

chk_if_increasing

Checks if a vector is strictly increasing.

Duplicated values are not allowed.

The function gives an error message if this is not the case.

Parameters

x_name	The name of the variable.
x	A variable of type Vector.

Author: Patrick Eriksson

Date: 2002-04-15

Definition at line 286 of file check_input.cc.

References is_increasing().

◆ chk_interpolation_grids() [1/2]

void chk_interpolation_grids	(	const String &	which_interpolation,
		ConstVectorView	old_grid,
		const Numeric &	new_grid,
		const Index	order,
		const Numeric &	extpolfac
	)

Check interpolation grids.

This function checks if old and new grid for an interpolation are ok. If not, it throws a detailed runtime error message. This is intended for workspace method input variable checking.

This is for the special case that the new grid is just a single Numeric, instead of a Vector. ("Red" interpolation.) It just calles the other more general chk_interpolation_grids function for which both grid arguments are vectors.

Parameters

[in]	which_interpolation	A string describing the interpolation for which the grids are intended.
[in]	old_grid	The original grid.
[in]	new_grid	The new grid.
[in]	order	Interpolation order. (Default value is 1.)
[in]	extpolfac	The extrapolation fraction. See gridpos function for details. Has a default value, which is consistent with gridpos.

Author: Stefan Buehler

Date: 2008-11-24

Definition at line 508 of file check_input.cc.

References chk_interpolation_grids().

◆ chk_interpolation_grids() [2/2]

void chk_interpolation_grids	(	const String &	which_interpolation,
		ConstVectorView	old_grid,
		ConstVectorView	new_grid,
		const Index	order,
		const Numeric &	extpolfac
	)

Check interpolation grids.

This function checks if old and new grid for an interpolation are ok. If not, it throws a detailed runtime error message. This is intended for workspace method input variable checking.

Parameters

[in]	which_interpolation	A string describing the interpolation for which the grids are intended.
[in]	old_grid	The original grid.
[in]	new_grid	The new grid.
[in]	order	Interpolation order. (Default value is 1.)
[in]	extpolfac	The extrapolation fraction. See gridpos function for details. Has a default value, which is consistent with gridpos.

Author: Stefan Buehler

Date: 2008-11-24

Definition at line 390 of file check_input.cc.

References is_decreasing(), is_increasing(), max, min, and ConstVectorView::nelem().

Referenced by abs_scalar_gasExtractFromLookup(), atm_fields_compactAddSpecies(), AtmFieldsCalc(), chk_interpolation_grids(), chk_single_scattering_data(), opt_prop_sptFromData(), pha_mat_sptFromDataDOITOpt(), pha_mat_sptFromMonoData(), and scat_data_monoCalc().

◆ chk_matrix_ncols()

void chk_matrix_ncols	(	const String &	x_name,
		ConstMatrixView	x,
		const Index &	l
	)

chk_matrix_ncols

Checks that a matrix has the specified number of columns.

The function gives an error message if this is not the case.

Parameters

x_name	The name of the variable.
x	A matrix.
l	The expected length of x.

Author: Patrick Eriksson

Date: 2002-05-16

Definition at line 539 of file check_input.cc.

References ConstMatrixView::ncols().

Referenced by GasAbsLookup::Adapt(), sensor_posAddRgeoid(), and surfaceFlatRefractiveIndex().

◆ chk_matrix_nrows()

void chk_matrix_nrows	(	const String &	x_name,
		ConstMatrixView	x,
		const Index &	l
	)

chk_matrix_nrows

Checks that a matrix has the specified number of rows.

The function gives an error message if this is not the case.

Parameters

x_name	The name of the variable.
x	A matrix.
l	The expected length of x.

Author: Patrick Eriksson

Date: 2002-05-16

Definition at line 568 of file check_input.cc.

References ConstMatrixView::nrows().

Referenced by GasAbsLookup::Adapt().

◆ chk_not_empty()

void chk_not_empty	(	const String &	x_name,
		const Agenda &	x
	)

chk_not_empty

Checks that an agenda is not empty.

The function gives an error message if the agenda is empty.

Parameters

x_name	The name of the agenda.
x	A variable of type Agenda.

Author: Patrick Eriksson

Date: 2002-08-20

Definition at line 880 of file check_input.cc.

References Agenda::nelem().

Referenced by cloud_RT_surface(), doit_i_fieldIterate(), doit_i_fieldUpdate1D(), doit_i_fieldUpdateSeq1D(), doit_i_fieldUpdateSeq3D(), doit_scat_fieldCalc(), doit_scat_fieldCalcLimb(), and ScatteringDoit().

◆ chk_not_negative()

void chk_not_negative	(	const String &	x_name,
		const Numeric &	x
	)

chk_not_negative

Checks that a variable of type Numeric is 0 or positive.

The function gives an error message if this is not the case.

Parameters

x_name	The name of the variable.
x	A variable of type Numeric.

Author: Patrick Eriksson

Date: 2002-04-15

Definition at line 157 of file check_input.cc.

Referenced by surfaceBlackbody(), surfaceFlatReflectivity(), surfaceFlatRefractiveIndex(), surfaceFlatVaryingEmissivity(), and surfaceLambertianSimple().

◆ chk_pnd_field_raw_only_in_cloudbox()

void chk_pnd_field_raw_only_in_cloudbox	(	const Index &	dim,
		const ArrayOfGriddedField3 &	pnd_field_raw,
		ConstVectorView	p_grid,
		ConstVectorView	lat_grid,
		ConstVectorView	lon_grid,
		const ArrayOfIndex &	cloudbox_limits
	)

chk_pnd_field_raw_only_in_cloudbox

Checks whether the pnd_field is zero outside the cloudbox. This is of a higher level than chk_pnd_data because it does not require any filename and because it works on all pnd_field_raw rather than just one element. Otherwise, it is mostly a new implementation of the same functionality.

Parameters

dim	The atmospheric dimensionality.
pnd_field_raw	All pnd_field_raw data.
p_grid	Pressure grid.
lat_grid	Latitude grid.
lon_grid	Longitude grid.
cloudbox_limits	The edges of the cloudbox.

Author: Gerrit Holl

Date: 2011-03-24

Definition at line 1211 of file check_input.cc.

References GFIELD3_LAT_GRID, GFIELD3_LON_GRID, GFIELD3_P_GRID, and Array< base >::nelem().

Referenced by pnd_fieldCalc().

◆ chk_size() [1/8]

template<class T >

void chk_size	(	const String &	x_name,
		const Array< T > &	x,
		const Index &	c
	)

Check the size of an array.

Checks the size of an Array. Cloned from Patricks similar function for Vector.

The function throws a runtime_error if the size is not correct.

This is a template function that works for any array type.

Parameters

x_name	The name of the variable.
x	A variable of type ArrayOfIndex.
c	The size to match

Author: Stefan Buehler

Date: 2007-05-18

Definition at line 250 of file check_input.h.

References Array< base >::nelem().

◆ chk_size() [2/8]

void chk_size	(	const String &	x_name,
		ConstMatrixView	x,
		const Index &	r,
		const Index &	c
	)

Runtime check for size of Matrix.

This is the runtime version of is_size. An appropriate error message is generated if the size is not correct.

Parameters

x_name	The name of the agenda.
x	A variable of type Agenda.
r	Required number of rows
c	Required number of columns

Author: Stefan Buehler

Date: 2002-11-29

Definition at line 942 of file check_input.cc.

References is_size(), ConstMatrixView::ncols(), and ConstMatrixView::nrows().

◆ chk_size() [3/8]

void chk_size	(	const String &	x_name,
		ConstTensor3View	x,
		const Index &	p,
		const Index &	r,
		const Index &	c
	)

Runtime check for size of Tensor.

This is the runtime version of is_size. An appropriate error message is generated if the size is not correct.

Parameters

x_name	The name of the agenda.
x	A variable of type Agenda.
p	Required number of pages
r	Required number of rows
c	Required number of columns

Author: Stefan Buehler

Date: 2002-11-29

Definition at line 977 of file check_input.cc.

References is_size(), ConstTensor3View::ncols(), ConstTensor3View::npages(), and ConstTensor3View::nrows().

◆ chk_size() [4/8]

void chk_size	(	const String &	x_name,
		ConstTensor4View	x,
		const Index &	b,
		const Index &	p,
		const Index &	r,
		const Index &	c
	)

Runtime check for size of Tensor.

This is the runtime version of is_size. An appropriate error message is generated if the size is not correct.

Parameters

x_name	The name of the agenda.
x	A variable of type Agenda.
b	Required number of books
p	Required number of pages
r	Required number of rows
c	Required number of columns

Author: Stefan Buehler

Date: 2002-11-29

Definition at line 1016 of file check_input.cc.

References is_size(), ConstTensor4View::nbooks(), ConstTensor4View::ncols(), ConstTensor4View::npages(), and ConstTensor4View::nrows().

◆ chk_size() [5/8]

void chk_size	(	const String &	x_name,
		ConstTensor5View	x,
		const Index &	s,
		const Index &	b,
		const Index &	p,
		const Index &	r,
		const Index &	c
	)

Runtime check for size of Tensor.

This is the runtime version of is_size. An appropriate error message is generated if the size is not correct.

Parameters

x_name	The name of the agenda.
x	A variable of type Agenda.
s	Required number of shelves
b	Required number of books
p	Required number of pages
r	Required number of rows
c	Required number of columns

Author: Stefan Buehler

Date: 2002-11-29

Definition at line 1059 of file check_input.cc.

References is_size(), ConstTensor5View::nbooks(), ConstTensor5View::ncols(), ConstTensor5View::npages(), ConstTensor5View::nrows(), and ConstTensor5View::nshelves().

◆ chk_size() [6/8]

void chk_size	(	const String &	x_name,
		ConstTensor6View	x,
		const Index &	v,
		const Index &	s,
		const Index &	b,
		const Index &	p,
		const Index &	r,
		const Index &	c
	)

Runtime check for size of Tensor.

This is the runtime version of is_size. An appropriate error message is generated if the size is not correct.

Parameters

x_name	The name of the agenda.
x	A variable of type Agenda.
v	Required number of vitrines
s	Required number of shelves
b	Required number of books
p	Required number of pages
r	Required number of rows
c	Required number of columns

Author: Stefan Buehler

Date: 2002-11-29

Definition at line 1106 of file check_input.cc.

References is_size(), ConstTensor6View::nbooks(), ConstTensor6View::ncols(), ConstTensor6View::npages(), ConstTensor6View::nrows(), ConstTensor6View::nshelves(), and ConstTensor6View::nvitrines().

◆ chk_size() [7/8]

void chk_size	(	const String &	x_name,
		ConstTensor7View	x,
		const Index &	l,
		const Index &	v,
		const Index &	s,
		const Index &	b,
		const Index &	p,
		const Index &	r,
		const Index &	c
	)

Runtime check for size of Tensor.

This is the runtime version of is_size. An appropriate error message is generated if the size is not correct.

Parameters

x_name	The name of the agenda.
x	A variable of type Agenda.
l	Required number of libraries
v	Required number of vitrines
s	Required number of shelves
b	Required number of books
p	Required number of pages
r	Required number of rows
c	Required number of columns

Author: Stefan Buehler

Date: 2002-11-29

Definition at line 1157 of file check_input.cc.

References is_size(), ConstTensor7View::nbooks(), ConstTensor7View::ncols(), ConstTensor7View::nlibraries(), ConstTensor7View::npages(), ConstTensor7View::nrows(), ConstTensor7View::nshelves(), and ConstTensor7View::nvitrines().

◆ chk_size() [8/8]

void chk_size	(	const String &	x_name,
		ConstVectorView	x,
		const Index &	c
	)

Runtime check for size of Vector.

This is the runtime version of is_size. An appropriate error message is generated if the size is not correct.

Parameters

x_name	The name of the agenda.
x	A variable of type Agenda.
c	Required number of columns

Author: Stefan Buehler

Date: 2002-11-29

Definition at line 911 of file check_input.cc.

References is_size(), and ConstVectorView::nelem().

Referenced by abs_coefCalcFromXsec(), GasAbsLookup::Adapt(), chk_single_scattering_data(), doit_i_fieldUpdate1D(), doit_i_fieldUpdateSeq1D(), doit_i_fieldUpdateSeq3D(), and doit_za_grid_optCalc().

◆ chk_vector_length() [1/2]

void chk_vector_length	(	const String &	x1_name,
		const String &	x2_name,
		ConstVectorView	x1,
		ConstVectorView	x2
	)

chk_vector_length

Checks if two vectors have the same length.

The function gives an error message if this is not the case.

Parameters

x1_name	The name of the first vector
x2_name	The name of the second vector
x1	The first vector.
x2	The second vector.

Author: Patrick Eriksson

Date: 2002-04-15

Definition at line 253 of file check_input.cc.

References ConstVectorView::nelem().

◆ chk_vector_length() [2/2]

void chk_vector_length	(	const String &	x_name,
		ConstVectorView	x,
		const Index &	l
	)

chk_vector_length

Checks that a vector has the specified length.

The function gives an error message if this is not the case.

Parameters

x_name	The name of the variable.
x	A variable of type Vector.
l	The expected length of x.

Author: Patrick Eriksson

Date: 2002-04-15

Definition at line 222 of file check_input.cc.

References ConstVectorView::nelem().

Referenced by GasAbsLookup::Adapt(), chk_if_equal(), ppath_calc(), and rte_posAddRgeoid().

Functions

Detailed Description

Function Documentation

◆ chk_atm_field() [1/2]

◆ chk_atm_field() [2/2]

◆ chk_atm_grids()

◆ chk_atm_surface()

◆ chk_contains()

◆ chk_if_bool()

◆ chk_if_decreasing()

◆ chk_if_equal()

◆ chk_if_in_range() [1/2]

◆ chk_if_in_range() [2/2]

◆ chk_if_increasing() [1/2]

◆ chk_if_increasing() [2/2]

◆ chk_interpolation_grids() [1/2]

◆ chk_interpolation_grids() [2/2]

◆ chk_matrix_ncols()

◆ chk_matrix_nrows()

◆ chk_not_empty()

◆ chk_not_negative()

◆ chk_pnd_field_raw_only_in_cloudbox()

◆ chk_size() [1/8]

◆ chk_size() [2/8]

◆ chk_size() [3/8]

◆ chk_size() [4/8]

◆ chk_size() [5/8]

◆ chk_size() [6/8]

◆ chk_size() [7/8]

◆ chk_size() [8/8]

◆ chk_vector_length() [1/2]

◆ chk_vector_length() [2/2]