serif::discretization::quadrature::Policy Class Reference

The Policy class is used to determine the appropriate order and other relevant information for the integration rule based on a given quadrature query. It uses a RuleSet to determine the appropriate order and other relevant information for the integration rule. More...

#include <policy.hpp>

Collaboration diagram for serif::discretization::quadrature::Policy:

Public Member Functions
	Policy (RuleSet ruleSet)
	Constructs a Policy with the given RuleSet.
Resolution	resolve (const Query &query) const
	Resolves the appropriate order and other relevant information for the integration rule based on the given quadrature query.
const RuleSet &	rules () const noexcept
	Inspect the authored quadrature controls without changing preparation.

Private Member Functions
const RuleControl &	get_role_control (QuadratureRole role) const
	Retrieves the RuleControl for the given quadrature role. This is used to determine the appropriate order and other relevant information for the integration rule.

Static Private Member Functions
static int	compute_base_order (const Query &query)
	Computes the base order for the given quadrature query. This is used to determine the appropriate order for the integration rule.

Private Attributes
RuleSet	m_ruleSet
	The RuleSet used to determine the appropriate order and other relevant information for the integration rule.

Detailed Description

The Policy class is used to determine the appropriate order and other relevant information for the integration rule based on a given quadrature query. It uses a RuleSet to determine the appropriate order and other relevant information for the integration rule.

Constructor & Destructor Documentation

Policy()

serif::discretization::quadrature::Policy::Policy ( RuleSet ruleSet )

explicit

Constructs a Policy with the given RuleSet.

Parameters

ruleSet

The RuleSet used to determine the appropriate order and other relevant information for the integration rule.

Member Function Documentation

compute_base_order()

int serif::discretization::quadrature::Policy::compute_base_order ( const Query & query )

staticnodiscardprivate

Computes the base order for the given quadrature query. This is used to determine the appropriate order for the integration rule.

Parameters

query

The quadrature query used to determine the base order.

Returns

The base order for the given quadrature query.

get_role_control()

const RuleControl & serif::discretization::quadrature::Policy::get_role_control ( QuadratureRole role ) const

nodiscardprivate

Retrieves the RuleControl for the given quadrature role. This is used to determine the appropriate order and other relevant information for the integration rule.

Parameters

role	The quadrature role used to retrieve the RuleControl.

Returns

The RuleControl for the given quadrature role.

resolve()

Resolution serif::discretization::quadrature::Policy::resolve ( const Query & query ) const

nodiscard

Resolves the appropriate order and other relevant information for the integration rule based on the given quadrature query.

Parameters

query

The quadrature query used to determine the appropriate order and other relevant information for the integration rule.

Returns

The resolution containing the appropriate order and other relevant information for the integration rule.

rules()

const RuleSet & serif::discretization::quadrature::Policy::rules ( ) const

inlinenodiscardnoexcept

Inspect the authored quadrature controls without changing preparation.

Member Data Documentation

m_ruleSet

RuleSet serif::discretization::quadrature::Policy::m_ruleSet

private

The RuleSet used to determine the appropriate order and other relevant information for the integration rule.

---

The documentation for this class was generated from the following files:

• src/include/serif/discretization/quadrature/policy.hpp
• src/lib/serif/discretization/quadrature/policy.cpp