#include <MetricEigenvalue.h>

Inheritance diagram for Nektar::MetricEigenvalue:

Static Public Member Functions
static MetricSharedPtr	create (TiXmlElement *metric, bool generate)

Static Public Member Functions inherited from Nektar::MetricRegex
static MetricSharedPtr	create (TiXmlElement *metric, bool generate)

Static Public Attributes
static std::string	type

static std::string	defaultTolerance = "1e-03"

Static Public Attributes inherited from Nektar::MetricRegex
static std::string	type

Protected Member Functions
	MetricEigenvalue (TiXmlElement *metric, bool generate)

void	v_Generate (std::istream &pStdout, std::istream &pStderr) override
	Virtual function to generate the metric. Should be redefined in derived classes. More...

Protected Member Functions inherited from Nektar::MetricRegex
	MetricRegex (TiXmlElement *metric, bool generate)
	Constructor. More...

bool	v_Test (std::istream &pStdout, std::istream &pStderr) override
	Test output against a regex expression and set of matches. More...

void	v_Generate (std::istream &pStdout, std::istream &pStderr) override
	Test output against a regex expression and set of matches. More...

virtual bool	v_Test (std::istream &pStdout, std::istream &pStderr)=0
	Virtual function to test the metric. Should be redefined in derived classes. More...

virtual void	v_Generate (std::istream &pStdout, std::istream &pSrderr)=0
	Virtual function to generate the metric. Should be redefined in derived classes. More...

Protected Attributes
std::string	m_varTolerance

Protected Attributes inherited from Nektar::MetricRegex
std::regex	m_regex
	Storage for the boost regex. More...

std::vector< std::vector< MetricRegexFieldValue > >	m_matches
	Stores the multiple matches defined in each <MATCH> tag. More...

bool	m_unordered = false
	If true, regex matches may be in any order in output. More...

bool	m_useStderr = false
	If true, use stderr for testing/generation instead of stdout. More...

Protected Attributes inherited from Nektar::Metric
int	m_id
	Stores the ID of this metric. More...

std::string	m_type
	Stores the type of this metric (uppercase). More...

bool	m_generate
	Determines whether to generate this metric or not. More...

bool	m_average = false
	Indicates whether a metric supports averaging results from multiple runs. More...

TiXmlElement *	m_metric
	Pointer to XML structure containing metric definition. More...

Additional Inherited Members
Public Member Functions inherited from Nektar::MetricRegex
	~MetricRegex () override

Public Member Functions inherited from Nektar::Metric
	Metric (TiXmlElement *metric, bool generate)
	Constructor. More...

virtual	~Metric ()=default

bool	Test (std::istream &pStdout, std::istream &pStderr)
	Calls a metric's `v_Test` function (or `v_Generate` if `m_generate`). More...

void	Generate (std::istream &pStdout, std::istream &pStderr)

std::string	GetType ()
	Return metric type. More...

int	GetID ()
	Return metric ID. More...

bool	SupportsAverage () const
	Return whether this metric supports averaging results from multiple runs. More...

Detailed Description

Definition at line 43 of file MetricEigenvalue.h.

Constructor & Destructor Documentation

◆ MetricEigenvalue()

Nektar::MetricEigenvalue::MetricEigenvalue	(	TiXmlElement *	metric,
		bool	generate
	)

protected

Definition at line 47 of file MetricEigenvalue.cpp.

    : MetricRegex(metric, generate)
{
    // We do not mind which order the converged eigenvalues are listed.
    m_unordered = true;
 
    // Regex for FP numbers of forms: 120, -23, 4.345, 2.4563e-01, -nan
    std::string fp = R"(-?\d+\.?\d*(?:e[+-]\d+)?|-?nan)";
 
    // Set up the regular expression. This matches lines beginning with EV:
    // followed by an eigenvalue index and then at least 2 floating-point
    // values comprising real and imaginary components of complex evals.
    // Comparison is made only on the captured eigenvalue components.
    m_regex = R"(^EV:\s+\d+\s+()" + fp + ")\\s+(" + fp + ").*";
 
    // Find the number of iterations to match against.
    TiXmlElement *value = metric->FirstChildElement("value");
    ASSERTL0(value || m_generate, "Missing value tag for eigenvalue metric!");
 
    while (value)
    {
        ASSERTL0(value->Attribute("tolerance"),
                 "Missing tolerance in eigenvalue metric");
        ASSERTL0(!EmptyString(value->GetText()),
                 "Missing value in preconditioner metric.");
 
        MetricRegexFieldValue mag, angle;
 
        // Read valute as comma-separate mag,angle parts
        std::string cmplx = value->GetText();
        std::vector<std::string> cmpts;
        boost::split(cmpts, cmplx, boost::is_any_of(","));
        ASSERTL0(cmpts.size() == 2,
                 "Value should be magnitude and angle, separated by comma");
 
        mag.m_value        = cmpts[0];
        mag.m_useTolerance = true;
        mag.m_tolerance    = atof(value->Attribute("tolerance"));
 
        angle.m_value        = cmpts[1];
        angle.m_useTolerance = true;
        angle.m_tolerance    = atof(value->Attribute("tolerance"));
 
        if (!m_generate)
        {
            std::vector<MetricRegexFieldValue> tmp(2);
            tmp[0] = mag;
            tmp[1] = angle;
            m_matches.push_back(tmp);
        }
        else
        {
            m_varTolerance = value->Attribute("tolerance");
        }
 
        value = value->NextSiblingElement("value");
    }
}

References ASSERTL0, Nektar::EmptyString(), Nektar::Metric::m_generate, Nektar::MetricRegex::m_matches, Nektar::MetricRegex::m_regex, Nektar::MetricRegexFieldValue::m_tolerance, Nektar::MetricRegex::m_unordered, Nektar::MetricRegexFieldValue::m_useTolerance, Nektar::MetricRegexFieldValue::m_value, and m_varTolerance.

Referenced by create().

Member Function Documentation

◆ create()

static MetricSharedPtr Nektar::MetricEigenvalue::create	(	TiXmlElement *	metric,
		bool	generate
	)

inlinestatic

Definition at line 46 of file MetricEigenvalue.h.

    {
        return MetricSharedPtr(new MetricEigenvalue(metric, generate));
    }

References MetricEigenvalue().

◆ v_Generate()

void Nektar::MetricEigenvalue::v_Generate	(	std::istream &	pStdout,
		std::istream &	pSrderr
	)

overrideprotectedvirtual

Virtual function to generate the metric. Should be redefined in derived classes.

Parameters

pStdout	Reference to test output stream.
pSrderr	Reference to test error stream.

Implements Nektar::Metric.

Definition at line 106 of file MetricEigenvalue.cpp.

{
    // Run MetricRegex to generate matches.
    MetricRegex::v_Generate(pStdout, pStderr);
 
    // First remove all existing values.
    m_metric->Clear();
 
    // Now create new values.
    for (int i = 0; i < m_matches.size(); ++i)
    {
        ASSERTL0(m_matches[i].size() == 3,
                 "Wrong number of matches for regular expression.");
 
        std::string tol     = MetricEigenvalue::defaultTolerance;
        TiXmlElement *value = new TiXmlElement("value");
 
        if (m_varTolerance != "")
        {
            tol = m_varTolerance;
        }
 
        value->SetAttribute("index", m_matches[i][0].m_value);
        value->SetAttribute("tolerance", tol);
        value->LinkEndChild(new TiXmlText(m_matches[i][1].m_value + "," +
                                          m_matches[i][2].m_value));
        m_metric->LinkEndChild(value);
    }
}