doit_conv_flagAbs
- Workspace.doit_conv_flagAbs(self: pyarts.arts._Workspace, doit_conv_flag: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.doit_conv_flag, doit_iteration_counter: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = self.doit_iteration_counter, cloudbox_field_mono: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Tensor6]] = self.cloudbox_field_mono, cloudbox_field_mono_old: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Tensor6]] = self.cloudbox_field_mono_old, epsilon: Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Vector], max_iterations: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = 100, nonconv_return_nan: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Index]] = 0, verbosity: Optional[Union[pyarts.arts.WorkspaceVariable, pyarts.arts.Verbosity]] = self.verbosity) None
DOIT convergence test (maximum absolute difference).
The function calculates the absolute differences for two successive iteration fields. It picks out the maximum values for each Stokes component separately. The convergence test is fullfilled under the following conditions:
|I(m+1) - I(m)| < epsilon_1
: Intensity.|Q(m+1) - Q(m)| < epsilon_2
: The other Stokes components.|U(m+1) - U(m)| < epsilon_3
:|V(m+1) - V(m)| < epsilon_4
:
These conditions have to be valid for all positions in the cloudbox and for all directions.
Author(s): Claudia Emde
- Parameters:
doit_conv_flag (Index, optional) – Flag for the convergence test. See
doit_conv_flag
, defaults toself.doit_conv_flag
[INOUT]doit_iteration_counter (Index, optional) – Counter for number of iterations. See
doit_iteration_counter
, defaults toself.doit_iteration_counter
[INOUT]cloudbox_field_mono (Tensor6, optional) – Monochromatic radiation field inside the cloudbox. See
cloudbox_field_mono
, defaults toself.cloudbox_field_mono
[INOUT]cloudbox_field_mono_old (Tensor6, optional) – As
cloudbox_field_mono
but from previous iteration. Seecloudbox_field_mono_old
, defaults toself.cloudbox_field_mono_old
[IN]epsilon (Vector) – Limits for convergence. A vector with length matching
stokes_dim
with unit [W / (m^2 Hz sr)]. [IN]max_iterations (Index, optional) – Maximum number of iterations allowed to reach convergencelimit. Defaults to
100
[IN]nonconv_return_nan (Index, optional) – Flag whether to accept result at max_iterations (0=default)or whether to return NaNs in case of non-convergence atmax_iterations. Defaults to
0
[IN]verbosity (Verbosity) – ARTS verbosity. See
verbosity
, defaults toself.verbosity
[IN]