anonymous_namespace{CompareJacobiansJacobianAssembler.cpp} Namespace Reference

Functions
template<typename T> requires std::integral<T> || std::floating_point<T>
void	dump_py (std::ostream &fh, std::string const &var, T const val)
	Dumps a numeric value as a Python script snippet.
template<typename Vec>
void	dump_py_vec (std::ostream &fh, std::string const &var, Vec const &val)
	Dumps an arbitrary vector as a Python script snippet.
void	dump_py (std::ostream &fh, std::string const &var, std::vector< double > const &val)
	Dumps a std::vector<double> as a Python script snippet.
template<typename Derived>
void	dump_py (std::ostream &fh, std::string const &var, Eigen::ArrayBase< Derived > const &val, std::integral_constant< int, 1 >)
	Dumps an Eigen vector (array with 1 column) as a Python script snippet.
template<typename Derived, int ColsAtCompileTime>
void	dump_py (std::ostream &fh, std::string const &var, Eigen::ArrayBase< Derived > const &val, std::integral_constant< int, ColsAtCompileTime >)
	Dumps an Eigen array as a Python script snippet.
template<typename Derived>
void	dump_py (std::ostream &fh, std::string const &var, Eigen::ArrayBase< Derived > const &val)
	Dumps an Eigen array as a Python script snippet.
template<typename Derived>
void	dump_py (std::ostream &fh, std::string const &var, Eigen::MatrixBase< Derived > const &val)
	Dumps an Eigen matrix as a Python script snippet.
auto	signedAbsDiffRelDiff (auto const &mat_or_vec1, auto const &mat_or_vec2)
	(Signed) absolute and (symmetric) relative difference as Eigen::Array
template<typename MatOrVec>
auto	oneIfAboveThresholdElseZero (MatOrVec &&mat_or_vec, double const threshold)
bool	isSimilar (auto const &mat_or_vec1, auto const &mat_or_vec2, double const abs_tol, double const rel_tol)

Variables
const std::string	msg_fatal
	Will be printed if some consistency error is detected.

Function Documentation

dump_py() [1/6]

template<typename Derived>

void anonymous_namespace{CompareJacobiansJacobianAssembler.cpp}::dump_py	(	std::ostream &	fh,
		std::string const &	var,
		Eigen::ArrayBase< Derived > const &	val )

Dumps an Eigen array as a Python script snippet.

Definition at line 98 of file CompareJacobiansJacobianAssembler.cpp.

{
    dump_py(fh, var, val,
            std::integral_constant<int, Derived::ColsAtCompileTime>{});
}

References dump_py().

dump_py() [2/6]

template<typename Derived>

void anonymous_namespace{CompareJacobiansJacobianAssembler.cpp}::dump_py	(	std::ostream &	fh,
		std::string const &	var,
		Eigen::ArrayBase< Derived > const &	val,
		std::integral_constant< int, 1 >	)

Dumps an Eigen vector (array with 1 column) as a Python script snippet.

Definition at line 62 of file CompareJacobiansJacobianAssembler.cpp.

{
    dump_py_vec(fh, var, val);
}

References dump_py_vec().

dump_py() [3/6]

template<typename Derived, int ColsAtCompileTime>

void anonymous_namespace{CompareJacobiansJacobianAssembler.cpp}::dump_py	(	std::ostream &	fh,
		std::string const &	var,
		Eigen::ArrayBase< Derived > const &	val,
		std::integral_constant< int, ColsAtCompileTime >	)

Dumps an Eigen array as a Python script snippet.

Definition at line 71 of file CompareJacobiansJacobianAssembler.cpp.

{
    fh << var << " = np.array([\n";
    for (std::ptrdiff_t r = 0; r < val.rows(); ++r)
    {
        if (r != 0)
        {
            fh << ",\n";
        }
        fh << "    [";
        for (std::ptrdiff_t c = 0; c < val.cols(); ++c)
        {
            if (c != 0)
            {
                fh << ", ";
            }
            fh << val(r, c);
        }
        fh << "]";
    }
    fh << "])\n";
}

dump_py() [4/6]

template<typename Derived>

void anonymous_namespace{CompareJacobiansJacobianAssembler.cpp}::dump_py	(	std::ostream &	fh,
		std::string const &	var,
		Eigen::MatrixBase< Derived > const &	val )

Dumps an Eigen matrix as a Python script snippet.

Definition at line 107 of file CompareJacobiansJacobianAssembler.cpp.

{
    dump_py(fh, var, val.array());
}

References dump_py().

dump_py() [5/6]

void anonymous_namespace{CompareJacobiansJacobianAssembler.cpp}::dump_py	(	std::ostream &	fh,
		std::string const &	var,
		std::vector< double > const &	val )

Dumps a std::vector<double> as a Python script snippet.

Definition at line 54 of file CompareJacobiansJacobianAssembler.cpp.

{
    dump_py_vec(fh, var, val);
}

References dump_py_vec().

dump_py() [6/6]

template<typename T>
requires std::integral<T> || std::floating_point<T>

void anonymous_namespace{CompareJacobiansJacobianAssembler.cpp}::dump_py	(	std::ostream &	fh,
		std::string const &	var,
		T const	val )

Dumps a numeric value as a Python script snippet.

Definition at line 23 of file CompareJacobiansJacobianAssembler.cpp.

{
    fh << var << " = " << val << '\n';
}

Referenced by dump_py(), and dump_py().

dump_py_vec()

template<typename Vec>

void anonymous_namespace{CompareJacobiansJacobianAssembler.cpp}::dump_py_vec	(	std::ostream &	fh,
		std::string const &	var,
		Vec const &	val )

Dumps an arbitrary vector as a Python script snippet.

Definition at line 30 of file CompareJacobiansJacobianAssembler.cpp.

{
    fh << var << " = np.array([";
    for (decltype(val.size()) i = 0; i < val.size(); ++i)
    {
        if (i != 0)
        {
            if (i % 8 == 0)
            {
                // Print at most eight entries on one line,
                // indent with four spaces.
                fh << ",\n    ";
            }
            else
            {
                fh << ", ";
            }
        }
        fh << val[i];
    }
    fh << "])\n";
}

Referenced by dump_py(), and dump_py().

isSimilar()

bool anonymous_namespace{CompareJacobiansJacobianAssembler.cpp}::isSimilar	(	auto const &	mat_or_vec1,
		auto const &	mat_or_vec2,
		double const	abs_tol,
		double const	rel_tol )

Definition at line 142 of file CompareJacobiansJacobianAssembler.cpp.

{
    if (mat_or_vec1.size() == 0 || mat_or_vec2.size() == 0)
    {
        // either size is 0, ignore
        return true;
    }
    if (mat_or_vec1.rows() != mat_or_vec2.rows() ||
        mat_or_vec1.cols() != mat_or_vec2.cols())
    {
        return false;
    }
 
    auto const [abs_diff, rel_diff] =
        signedAbsDiffRelDiff(mat_or_vec1, mat_or_vec2);
    auto const abs_tol_exceeded = abs_diff.abs() > abs_tol;
    auto const rel_tol_exceeded = rel_diff.abs() > rel_tol;
 
    // similar if for no entry abs and rel tols are exceeded at the same time
    return !(abs_tol_exceeded && rel_tol_exceeded).any();
}

References signedAbsDiffRelDiff().

oneIfAboveThresholdElseZero()

template<typename MatOrVec>

auto anonymous_namespace{CompareJacobiansJacobianAssembler.cpp}::oneIfAboveThresholdElseZero	(	MatOrVec &&	mat_or_vec,
		double const	threshold )

Definition at line 133 of file CompareJacobiansJacobianAssembler.cpp.

{
    return (mat_or_vec <= threshold)
        .select(MatOrVec::Zero(mat_or_vec.rows(), mat_or_vec.cols()),
                MatOrVec::Ones(mat_or_vec.rows(), mat_or_vec.cols()))
        .eval();
}

signedAbsDiffRelDiff()

auto anonymous_namespace{CompareJacobiansJacobianAssembler.cpp}::signedAbsDiffRelDiff	(	auto const &	mat_or_vec1,
		auto const &	mat_or_vec2 )

(Signed) absolute and (symmetric) relative difference as Eigen::Array

Definition at line 119 of file CompareJacobiansJacobianAssembler.cpp.

{
    auto abs_diff = (mat_or_vec2 - mat_or_vec1).array().eval();
    auto const rel_diff =
        (abs_diff == 0.0)
            .select(
                abs_diff,
                2. * abs_diff /
                    (mat_or_vec1.cwiseAbs() + mat_or_vec2.cwiseAbs()).array())
            .eval();
    return std::pair{std::move(abs_diff), std::move(rel_diff)};
}

Referenced by isSimilar().

Variable Documentation

msg_fatal

const std::string anonymous_namespace{CompareJacobiansJacobianAssembler.cpp}::msg_fatal

Initial value:

=
    "The local matrices M or K or the local vectors b assembled with the two "
    "different Jacobian assemblers differ."

Will be printed if some consistency error is detected.

Definition at line 114 of file CompareJacobiansJacobianAssembler.cpp.