abs_lookupSetupBatch

Workspace.abs_lookupSetupBatch(self: pyarts.arts._Workspace, abs_p: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.abs_p, abs_t: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.abs_t, abs_t_pert: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.abs_t_pert, abs_vmrs: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Matrix]] = self.abs_vmrs, abs_nls: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfArrayOfSpeciesTag]] = self.abs_nls, abs_nls_pert: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = self.abs_nls_pert, abs_species: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfArrayOfSpeciesTag]] = self.abs_species, batch_atm_fields_compact: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.ArrayOfGriddedField4]] = self.batch_atm_fields_compact, abs_p_interp_order: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.abs_p_interp_order, abs_t_interp_order: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.abs_t_interp_order, abs_nls_interp_order: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.abs_nls_interp_order, atmosphere_dim: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.atmosphere_dim, p_step: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Numeric]] = 0.05, t_step: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Numeric]] = 20, h2o_step: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Numeric]] = 100, extremes: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector]] = Vector{}, robust: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = 0, check_gridnames: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = 0, verbosity: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Verbosity]] = self.verbosity) → None

Set up input parameters for abs_lookupCalc for batch calculations.

This method performs a similar task as abs_lookupSetup(), with the difference that the lookup table setup is not for a single atmospheric state, but for a whole batch of them, stored in batch_atm_fields_compact.

The method checks abs_species to decide which species require nonlinear treatment in the lookup table.

The method also checks which range of pressures, temperatures, and VMRs occurs, and sets abs_p, abs_t, abs_t_pert, and abs_vmrs accordingly.

If nonlinear species are present, abs_nls and abs_nls_pert are also generated.

Max and min values of H2O and temperature are adjusted to allow for numerical perturbations in Jacobian calculation.

The input variables abs_nls_interp_order and abs_t_interp_order are used to make sure that there are enough points in abs_nls_pert and abs_t_pert for the chosen interpolation order.

The method checks each given field using atmfields_checkedCalc(). If a field does not pass the check, a run-time error is thrown. To prevent this, the parameter robust can be set to one: Invalid atmospheres are skipped, but the run continues. This matches the robust behaviour of ybatchCalc().

See also

abs_lookupSetup()

Author(s): Stefan Buehler

Parameters:

  • abs_p (Vector, optional) – List of pressures to be used for the calculation of absorption. See abs_p, defaults to self.abs_p [OUT]

  • abs_t (Vector, optional) – List of temperatures to be used for the calculation of absorption. See abs_t, defaults to self.abs_t [OUT]

  • abs_t_pert (Vector, optional) – Temperature perturbations for the absorption lookup table. See abs_t_pert, defaults to self.abs_t_pert [OUT]

  • abs_vmrs (Matrix, optional) – The VMRs (unit of absolute number) on the abs_p grid. See abs_vmrs, defaults to self.abs_vmrs [OUT]

  • abs_nls (ArrayOfArrayOfSpeciesTag, optional) – Nonlinear species for absorption lookup table generation. See abs_nls, defaults to self.abs_nls [OUT]

  • abs_nls_pert (Vector, optional) – Fractional perturbations for the nonlinear species in the absorption. See abs_nls_pert, defaults to self.abs_nls_pert [OUT]

  • abs_species (ArrayOfArrayOfSpeciesTag, optional) – Tag groups for gas absorption. See abs_species, defaults to self.abs_species [IN]

  • batch_atm_fields_compact (ArrayOfGriddedField4, optional) – An array of compact atmospheric states. See batch_atm_fields_compact, defaults to self.batch_atm_fields_compact [IN]

  • abs_p_interp_order (Index, optional) – The interpolation order to use when interpolating absorption. See abs_p_interp_order, defaults to self.abs_p_interp_order [IN]

  • abs_t_interp_order (Index, optional) – The interpolation order to use when interpolating absorption between. See abs_t_interp_order, defaults to self.abs_t_interp_order [IN]

  • abs_nls_interp_order (Index, optional) – The interpolation order to use when interpolating absorption between. See abs_nls_interp_order, defaults to self.abs_nls_interp_order [IN]

  • atmosphere_dim (Index, optional) – The atmospheric dimensionality (1-3). See atmosphere_dim, defaults to self.atmosphere_dim [IN]

  • p_step (Numeric, optional) – Grid step in log10(p[Pa]) (base 10 logarithm). Defaults to 0.05 [IN]

  • t_step (Numeric, optional) – The temperature variation grid step in Kelvin. The true step can become finer than this, if required by the interpolation order. Defaults to 20 [IN]

  • h2o_step (Numeric, optional) – The H2O variation grid step [fractional], if H2O variations are done (which is determined automatically, based on abs_species and the atmospheric dimension). As for T, the true step can turn out finer if required by the interpolation order. Defaults to 100 [IN]

  • extremes (Vector, optional) – You can give here explicit extreme values to add to abs_t_pert and abs_nls_pert. The order is [t_pert_min, t_pert_max, nls_pert_min, nls_pert_max]. Defaults to [] [IN]

  • robust (Index, optional) – A flag with value 1 or 0. If set to one, the batch setup will continue, even if individual fields are invalid. This is consistent with the behaviour of ybatchCalc(). Defaults to 0 [IN]

  • check_gridnames (Index, optional) – A flag with value 1 or 0. If set to one, the gridnames of every atm_fields_compact are checked. Defaults to 0 [IN]

  • verbosity (Verbosity) – ARTS verbosity. See verbosity, defaults to self.verbosity [IN]