Reaktoro A unified framework for modeling chemically reactive systems
RegularizerOptions Struct Reference

A type that describes the options for regularizing linear constraints. More...

#include <Regularizer.hpp>

Inheritance diagram for RegularizerOptions:
[legend]

## Public Attributes

bool echelonize = true
The boolean flag that indicates if echelonization should be performed. More...

unsigned max_denominator = 0
The maximum denominator that can exist in the coefficient matrix A. More...

## Detailed Description

A type that describes the options for regularizing linear constraints.

## ◆ echelonize

 bool echelonize = true

The boolean flag that indicates if echelonization should be performed.

The echelonization of the linear constraints can help on robustness and accuracy by minimizing round-off errors.

## ◆ max_denominator

 unsigned max_denominator = 0

The maximum denominator that can exist in the coefficient matrix A.

Set this option to zero if the coefficients in A are not represented by rational numbers. Otherwise, set it to the maximum denominator that can represent the coefficients in rational form. This is a useful information to eliminate round-off errors when assembling the regularized coefficient matrix.

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