ScalarField Class Reference

Abstract interface for all scalar fields. More...

#include <ScalarField.hpp>

Inheritance diagram for ScalarField:

Public Member Functions
	ScalarField (Real upper_bound, Real lower_bound) noexcept
	Constructs a ScalarField from by assigning member directly.
virtual	~ScalarField () noexcept
	Virtual destructor (C++ Core Guidelines C.127)
virtual bool	IsConstant () const noexcept=0
	Returns true if the field is constant. More...
virtual Real	at (const Point &p) const noexcept=0
	Returns the value at a given Point. More...

Static Public Member Functions
static std::unique_ptr< const ScalarField >	Create (const pugi::xml_node &scalar_field_node) noexcept
	Factory method to create new ScalarField from an XML document.

Public Attributes
const Real	upper_bound
	Upper bound on values that will be encountered (C++ Core Guidelines C.131)
const Real	lower_bound
	Lower bound on values that will be encountered (C++ Core Guidelines C.131)

Detailed Description

Abstract interface for all scalar fields.

Member Function Documentation

at()

virtual Real ScalarField::at ( const Point &  p ) const

pure virtualnoexcept

Returns the value at a given Point.

Implemented in ConstantField, and LinearField.

IsConstant()

virtual bool ScalarField::IsConstant ( ) const

pure virtualnoexcept

Returns true if the field is constant.

Used during input parsing to check if a TransportMethod is valid

Implemented in ConstantField, and LinearField.

---

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

• /Users/atumulak/Developer/minimc/src/ScalarField.hpp