#include <ImplicitReachSolver.hpp>

Collaboration diagram for openswmm::fv::ImplicitReachSolver::Result:

Public Member Functions
bool	converged () const
	Report whether the nonlinear reach residual passed every physical budget.

Public Attributes
Status	status = Status::InvalidInput

int	newton_iterations = 0

int	backtracks = 0

double	scaled_residual = 0.0

double	max_volume_residual = 0.0

double	max_momentum_residual = 0.0

double	linear_relative_residual = 0.0

int	gmres_iterations = 0

int	gmres_solves = 0

int	linear_fallbacks = 0

std::size_t	max_gmres_workspace_bytes = 0

LinearResult	last_linear

Member Function Documentation

◆ converged()

bool openswmm::fv::ImplicitReachSolver::Result::converged ( ) const

inline

Report whether the nonlinear reach residual passed every physical budget.

Returns: True only for Status::Converged; no additional validation is performed.

Member Data Documentation

◆ backtracks

int openswmm::fv::ImplicitReachSolver::Result::backtracks = 0

◆ gmres_iterations

int openswmm::fv::ImplicitReachSolver::Result::gmres_iterations = 0

◆ gmres_solves

int openswmm::fv::ImplicitReachSolver::Result::gmres_solves = 0

◆ last_linear

LinearResult openswmm::fv::ImplicitReachSolver::Result::last_linear

◆ linear_fallbacks

int openswmm::fv::ImplicitReachSolver::Result::linear_fallbacks = 0

◆ linear_relative_residual

double openswmm::fv::ImplicitReachSolver::Result::linear_relative_residual = 0.0

◆ max_gmres_workspace_bytes

std::size_t openswmm::fv::ImplicitReachSolver::Result::max_gmres_workspace_bytes = 0

◆ max_momentum_residual

double openswmm::fv::ImplicitReachSolver::Result::max_momentum_residual = 0.0

◆ max_volume_residual

double openswmm::fv::ImplicitReachSolver::Result::max_volume_residual = 0.0

◆ newton_iterations

int openswmm::fv::ImplicitReachSolver::Result::newton_iterations = 0

◆ scaled_residual

double openswmm::fv::ImplicitReachSolver::Result::scaled_residual = 0.0

◆ status

Status openswmm::fv::ImplicitReachSolver::Result::status = Status::InvalidInput

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

/home/runner/work/openswmm.engine/openswmm.engine/src/engine/hydraulics/fv/ImplicitReachSolver.hpp

Public Member Functions

Public Attributes