Controls for the stiff arm. More...

#include <line/solvers/fluid/fluid_stiff.h>

Collaboration diagram for line::fluid::FluidStiffOptions:

Public Attributes
std::string	solver = "default"
	Refuses any named MATLAB solver: see the gate below.
bool	stiff = true
	options.stiff: keep the nonnegativity projection
double	rtol = 1e-4
	the value solver_fluid.h hands LSODA, FluidOptions::tol
double	atol = 1e-4
std::size_t	max_steps = 100000
bool	store_trajectory = false
std::function< bool(const double &, const std::vector< double > &)>	step_stop
	Per-accepted-step stop; see OdeOptions::step_stop and solver_fluid.h.

Detailed Description

Controls for the stiff arm.

stiff is options.stiff, the reference's choice between its accurate and its fast stiff solver. THAT CHOICE DOES NOT SURVIVE THE PORT as a choice of method: MATLAB picks between ode15s and ode23s, and this port has exactly one stiff method, so claiming either name would be a fiction. What the two arms differ in that IS expressible here is the NonNegative handling, which the reference clears for the fast arm because ode23s cannot honour it, and that is what the flag selects below. Tolerances come from the caller on both arms, as they do in the reference.

Definition at line 541 of file fluid_stiff.h.

Member Data Documentation

◆ atol

double line::fluid::FluidStiffOptions::atol = 1e-4

Definition at line 546 of file fluid_stiff.h.

Referenced by line::fluid::fluid_integrate_leg().

◆ max_steps

std::size_t line::fluid::FluidStiffOptions::max_steps = 100000

Definition at line 547 of file fluid_stiff.h.

◆ rtol

double line::fluid::FluidStiffOptions::rtol = 1e-4

the value solver_fluid.h hands LSODA, FluidOptions::tol

Definition at line 545 of file fluid_stiff.h.

Referenced by line::fluid::fluid_integrate_leg().

◆ solver

std::string line::fluid::FluidStiffOptions::solver = "default"

Refuses any named MATLAB solver: see the gate below.

Definition at line 543 of file fluid_stiff.h.

◆ step_stop

std::function<bool(const double&, const std::vector<double>&)> line::fluid::FluidStiffOptions::step_stop

Per-accepted-step stop; see OdeOptions::step_stop and solver_fluid.h.

Definition at line 550 of file fluid_stiff.h.

◆ stiff

bool line::fluid::FluidStiffOptions::stiff = true

options.stiff: keep the nonnegativity projection

Definition at line 544 of file fluid_stiff.h.

◆ store_trajectory

bool line::fluid::FluidStiffOptions::store_trajectory = false

Definition at line 548 of file fluid_stiff.h.

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

include/line/solvers/fluid/fluid_stiff.h

Public Attributes