propmat_clearskyAddLines

Workspace.propmat_clearskyAddLines(self: pyarts.arts._Workspace, propmat_clearsky: pyarts.arts.WorkspaceVariable | pyarts.arts.PropagationMatrix | None = self.propmat_clearsky, nlte_source: pyarts.arts.WorkspaceVariable | pyarts.arts.StokesVector | None = self.nlte_source, dpropmat_clearsky_dx: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfPropagationMatrix | None = self.dpropmat_clearsky_dx, dnlte_source_dx: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfStokesVector | None = self.dnlte_source_dx, f_grid: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.f_grid, abs_species: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfArrayOfSpeciesTag | None = self.abs_species, select_abs_species: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfSpeciesTag | None = self.select_abs_species, jacobian_quantities: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfRetrievalQuantity | None = self.jacobian_quantities, abs_lines_per_species: pyarts.arts.WorkspaceVariable | pyarts.arts.ArrayOfArrayOfAbsorptionLines | None = self.abs_lines_per_species, isotopologue_ratios: pyarts.arts.WorkspaceVariable | pyarts.arts.SpeciesIsotopologueRatios | None = self.isotopologue_ratios, rtp_pressure: pyarts.arts.WorkspaceVariable | pyarts.arts.Numeric | None = self.rtp_pressure, rtp_temperature: pyarts.arts.WorkspaceVariable | pyarts.arts.Numeric | None = self.rtp_temperature, rtp_nlte: pyarts.arts.WorkspaceVariable | pyarts.arts.EnergyLevelMap | None = self.rtp_nlte, rtp_vmr: pyarts.arts.WorkspaceVariable | pyarts.arts.Vector | None = self.rtp_vmr, nlte_do: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.nlte_do, lbl_checked: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = self.lbl_checked, lines_sparse_df: pyarts.arts.WorkspaceVariable | pyarts.arts.Numeric | None = 0, lines_sparse_lim: pyarts.arts.WorkspaceVariable | pyarts.arts.Numeric | None = 0, lines_speedup_option: pyarts.arts.WorkspaceVariable | pyarts.arts.String | None = 'None', no_negatives: pyarts.arts.WorkspaceVariable | pyarts.arts.Index | None = 1, verbosity: pyarts.arts.WorkspaceVariable | pyarts.arts.Verbosity | None = self.verbosity) None

Computes the line-by-line unpolarized absorption and adds it to the diagonal of propmat_clearsky and derivates to other variables. Does the same for NLTE variables if required.

If lines_speedup_option is not “None”, then some speed-up logic is applied. Valid speed-up logic other than “None” includes:

  • "LinearIndependent": Using a sparse-grid, the points are separated as [f0, f0+df[0], f0+df[0], f0+df[1]…] until the entire f_grid is covered. All sparse bins are on f_grid so df changes. A linear interpolation scheme is used between the bins to fill up the dense absorption. The maximum of df[n] is given by lines_sparse_df and the minimum transition between dense-to-sparse grid calculations are given by lines_sparse_lim.

  • "QuadraticIndependent": Using a sparse-grid, the points are separated as [f0, f0+0.5*df[0], f0+df[0], f0+df[0], f0+0.5*df[1], f0+df[1]…] until the entire f_grid is covered. All sparse bins are on f_grid so df changes. A quadratic interpolation scheme is used between the bins to fill up the dense absorption. The maximum of df[n] is given by lines_sparse_df and the minimum transition between dense-to-sparse grid calculations are given by lines_sparse_lim.

Please use sparse_f_gridFromFrequencyGrid() to see the sparse frequency grid

By default we discourage negative values, which are common when using one of the line mixing approximations. Change the value of no_negatives to 0 to allow these negative absorptions.

Author(s): Richard Larsson

Parameters:
  • propmat_clearsky (PropagationMatrix, optional) – This contains the absorption coefficients for one point in the atmosphere. See propmat_clearsky, defaults to self.propmat_clearsky [INOUT]

  • nlte_source (StokesVector, optional) – Variable to contain the additional source function due to NLTE effects. See nlte_source, defaults to self.nlte_source [INOUT]

  • dpropmat_clearsky_dx (ArrayOfPropagationMatrix, optional) – Partial derivative of absorption coefficients. See dpropmat_clearsky_dx, defaults to self.dpropmat_clearsky_dx [INOUT]

  • dnlte_source_dx (ArrayOfStokesVector, optional) – NLTE partial derivatives output is two parts: S * dB/dx + dS/dx * B. See dnlte_source_dx, defaults to self.dnlte_source_dx [INOUT]

  • f_grid (Vector, optional) – The frequency grid for monochromatic pencil beam calculations. See f_grid, defaults to self.f_grid [IN]

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

  • select_abs_species (ArrayOfSpeciesTag, optional) – A select species tag group from abs_species. See select_abs_species, defaults to self.select_abs_species [IN]

  • jacobian_quantities (ArrayOfRetrievalQuantity, optional) – The retrieval quantities in the Jacobian matrix. See jacobian_quantities, defaults to self.jacobian_quantities [IN]

  • abs_lines_per_species (ArrayOfArrayOfAbsorptionLines, optional) – A list of spectral line data for each tag. See abs_lines_per_species, defaults to self.abs_lines_per_species [IN]

  • isotopologue_ratios (SpeciesIsotopologueRatios, optional) – Contains the isotopologue ratios. See isotopologue_ratios, defaults to self.isotopologue_ratios [IN]

  • rtp_pressure (Numeric, optional) – Pressure at a radiative transfer point. See rtp_pressure, defaults to self.rtp_pressure [IN]

  • rtp_temperature (Numeric, optional) – Temperature at a radiative transfer point. See rtp_temperature, defaults to self.rtp_temperature [IN]

  • rtp_nlte (EnergyLevelMap, optional) – NLTE temperature/ratio at a radiative transfer point. See rtp_nlte, defaults to self.rtp_nlte [IN]

  • rtp_vmr (Vector, optional) – Absorption species abundances for radiative transfer calculations. See rtp_vmr, defaults to self.rtp_vmr [IN]

  • nlte_do (Index, optional) – Flag to perform Non-LTE calculations. See nlte_do, defaults to self.nlte_do [IN]

  • lbl_checked (Index, optional) – Flag to check if the line-by-line calculations will work. See lbl_checked, defaults to self.lbl_checked [IN]

  • lines_sparse_df (Numeric, optional) – The grid sparse separation. Defaults to 0 [IN]

  • lines_sparse_lim (Numeric, optional) – The dense-to-sparse limit. Defaults to 0 [IN]

  • lines_speedup_option (String, optional) – Speedup logic. Defaults to "None" [IN]

  • no_negatives (Index, optional) – Boolean. If it is true, line mixed bands each allocate their own compute data to ensure that they cannot produce negative absorption. Defaults to 1 [IN]

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