Template Class RmsNorm

• Defined in File RmsNorm.hpp

Inheritance Relationships

Base Type

• public AnalysisManager::NativeDynamicSolver::ErrorNorm< ScalarT, IdxT > (Template Class ErrorNorm)

Class Documentation

template<class ScalarT, typename IdxT>
class RmsNorm : public AnalysisManager::NativeDynamicSolver::ErrorNorm<ScalarT, IdxT>

Root-mean-square norm of component-wise tolerance-scaled errors.

Public Functions

inline RmsNorm(std::unique_ptr<State> abs_tol, RealT rel_tol)

Construct an RMS norm that owns the supplied absolute-tolerance vector.

Parameters:

• abs_tol – Component-wise absolute tolerances.

• rel_tol – Relative tolerance applied to the larger magnitude of the current and previous states.

virtual RealT errorNorm(State &err, State &y, State &yprev, GridKit::LinearAlgebra::VectorHandler<ScalarT, IdxT> &handler, GridKit::memory::MemorySpace memspace) const final

Compute the tolerance-scaled RMS norm through the supplied vector handler.