Settings of the Schur-condensed SOURCE STAGE (cf. More...

#include <facade_options.hpp>

Collaboration diagram for pops::SourceStageOptions:

Public Attributes
double	krylov_tol = 0.0

int	krylov_max_iters = 0

std::string	density = ""

std::string	momentum_x = ""

std::string	momentum_y = ""

std::string	energy = ""

int	bz_aux_component = -1

Detailed Description

Settings of the Schur-condensed SOURCE STAGE (cf.

System::set_source_stage / AmrSystem::set_source_stage). Groups the Krylov solve and the field DESCRIPTORS – a family of four adjacent std::string that were swappable at the call site.

Usage: built by the facade (or by the bindings, from the flat Python kwargs) then passed to set_source_stage. All defaults (empty POD) = bit-identical historical behavior. Contract: the DEFAULTS reproduce the old defaults of the flat parameters.

krylov_tol / krylov_max_iters: tolerance and budget of the stage Krylov solve (BiCGStab). <= 0 (default) = historical stepper constants (1e-10; 400 cartesian, 600 polar).
density / momentum_x / momentum_y / energy: DESCRIPTORS of the stage fields. EMPTY string (default) = canonical role (Density / MomentumX / MomentumY / optional Energy), bit-identical. Otherwise: a stable ROLE NAME ("density", "momentum_x", ...) or a VARIABLE NAME of the block. energy == "none" disables the energy update.
bz_aux_component: aux-channel component read as the magnetic field Omega. < 0 (default) = canonical B_z channel (kAuxBaseComps), bit-identical. (Ignored by AmrSystem: mono-block stage on the canonical channel.)

Member Data Documentation

◆ bz_aux_component

int pops::SourceStageOptions::bz_aux_component = -1

◆ density

std::string pops::SourceStageOptions::density = ""

◆ energy

std::string pops::SourceStageOptions::energy = ""

◆ krylov_max_iters

int pops::SourceStageOptions::krylov_max_iters = 0

◆ krylov_tol

double pops::SourceStageOptions::krylov_tol = 0.0

◆ momentum_x

std::string pops::SourceStageOptions::momentum_x = ""

◆ momentum_y

std::string pops::SourceStageOptions::momentum_y = ""

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

include/pops/runtime/facade_options.hpp

SourceStageOptions Struct Reference¶

Public Attributes