This class uses implementations of CompositeSeriesBasisInterface to generate a function based on convolved function series. More...

#include <FunctionSeries.h>

Inheritance diagram for FunctionSeries:

[legend]

Public Member Functions
	FunctionSeries (const InputParameters &parameters)

virtual Real	evaluateValue (Real t, const Point &p) override
	Used in derived classes, equivalent to Function::value() More...

Real	expand ()
	Expand the function series at the current location and with the current coefficients. More...

Real	expand (const std::vector< Real > &coefficients)
	Expand the function using the provided coefficients at the current location. More...

std::size_t	getNumberOfTerms () const
	Returns the number of terms (coefficients) in the underlying function series. More...

Real	getStandardizedFunctionVolume () const
	Returns the volume of evaluation in the functional series standardized space. More...

const std::vector< std::size_t > &	getOrders () const
	Returns a vector of the functional orders in the underlying functional series. More...

const std::vector< Real > &	getGeneration ()
	Returns a vector of the generation-evaluated functional series at the current location. More...

const std::vector< Real > &	getExpansion ()
	Returns a vector of the expansion-evaluated functional series at the current location. More...

bool	isInPhysicalBounds (const Point &point) const
	Returns true if the provided point is within the set physical boundaries. More...

void	setLocation (const Point &point)
	Set the current evaluation location. More...

virtual void	meshChanged () override

void	useCache (bool use)
	Enable/disable the cache. More...

virtual Real	value (Real time, const Point &point) const final

Real	operator[] (std::size_t index) const
	Get the value of the coefficient at the corresponding index. More...

const std::vector< std::size_t > &	getCharacteristics () const
	Get a reference to the characteristics array. More...

const std::vector< Real > &	getCoefficients () const
	Get a read-only reference to the vector of coefficients. More...

std::vector< Real > &	getCoefficients ()
	Get a writeable reference to the vector of coefficients. More...

std::string	getCoefficientsTable () const
	Get a formatted string of the coefficients. More...

std::size_t	getSize () const
	Get the size, aka number of coefficients. More...

bool	isCompatibleWith (const MutableCoefficientsInterface &other) const
	Checks to see if another instance is compatible. More...

bool	isSizeEnforced () const
	Returns true if the size of the coefficient array is fixed and enforced. More...

void	enforceSize (bool enforce)
	Toggle whether the size of the coefficient array can be changed. More...

void	importCoefficients (const MutableCoefficientsInterface &other)
	Import the coefficients from another instance. More...

void	resize (std::size_t size, Real fill=0.0, bool fill_out_to_size=true)
	Resize the array, using the value for fill if the new size is larger. More...

void	setCharacteristics (const std::vector< std::size_t > &new_characteristics)
	Sets the characteristics array. More...

void	setCoefficients (const std::vector< Real > &new_coefficients)
	Set the coefficients using a copy operation. More...

void	setCoefficients (std::vector< Real > &&dropin_coefficients)
	Set the coefficients using a move operation (only works with temp objects) More...

Static Public Member Functions
static FunctionSeries &	checkAndConvertFunction (const Function &function, const std::string &typeName, const std::string &objectName)
	Static function to cast a Function to SeriesFunction. More...

Protected Member Functions
virtual void	coefficientsChanged () override
	Called when the coefficients have been changed. More...

void	invalidateCache ()
	Called by derived classes to invalidate the cache, perhaps due to a state change. More...

Protected Attributes
const std::vector< std::size_t >	_orders
	The vector holding the orders of each single series. More...

const std::vector< Real >	_physical_bounds
	The physical bounds of the function series. More...

std::unique_ptr< CompositeSeriesBasisInterface >	_series_type
	Stores a pointer to the functional series object. More...

const MooseEnum &	_series_type_name
	Stores the name of the current functional series type. More...

const MooseEnum &	_x
	Stores the name of the single function series to use in the x direction. More...

const MooseEnum &	_y
	Stores the name of the single function series to use in the y direction. More...

const MooseEnum &	_z
	Stores the name of the single function series to use in the z direction. More...

const MooseEnum &	_disc
	Stores the name of the single function series to use for a unit disc. More...

const MooseEnum &	_expansion_type
	The normalization type for expansion. More...

const MooseEnum &	_generation_type
	The normalization type for generation. More...

std::vector< std::size_t > &	_characteristics
	An array of integer characteristics that can be used to check compatibility. More...

std::vector< Real > &	_coefficients
	The coefficient array. More...

bool	_enforce_size
	Boolean that locks or allows resizing of the coefficient array. More...

const bool	_print_coefficients
	Boolean to flag if the coefficients should be printed when set. More...

Static Private Member Functions
static std::vector< std::size_t >	convertOrders (const std::vector< unsigned int > &orders)
	Static function to convert an array of `unsigned int` to `std::size_t`. More...

Private Attributes
std::unordered_map< hashing::HashValue, Real >	_cache
	Cached evaluations for each point. More...

Real	_current_time
	Stores the time evaluation of the cache. More...

bool	_enable_cache
	Flag for whether to cache values. More...

bool	_respect_time
	Flag for whether changes in time invalidate the cache. More...

const ConsoleStream &	_console
	MooseObject instance of `this` to provide access to `_console` More...

Friends
std::ostream &	operator<< (std::ostream &stream, const FunctionSeries &me)
	Returns a tabularized text stream of the currently stored coefficients. More...

Detailed Description

This class uses implementations of CompositeSeriesBasisInterface to generate a function based on convolved function series.

Its inheritance tree includes MutableCoefficientsInterface, which enables easy MultiApp transfers of coefficients.

Definition at line 25 of file FunctionSeries.h.

Constructor & Destructor Documentation

◆ FunctionSeries()

FunctionSeries::FunctionSeries ( const InputParameters & parameters )

Definition at line 75 of file FunctionSeries.C.

   : MutableCoefficientsFunctionInterface(this, parameters),
     _orders(convertOrders(getParam<std::vector<unsigned int>>("orders"))),
     _physical_bounds(getParam<std::vector<Real>>("physical_bounds")),
     _series_type_name(getParam<MooseEnum>("series_type")),
     _x(getParam<MooseEnum>("x")),
     _y(getParam<MooseEnum>("y")),
     _z(getParam<MooseEnum>("z")),
     _disc(getParam<MooseEnum>("disc")),
     _expansion_type(getParam<MooseEnum>("expansion_type")),
     _generation_type(getParam<MooseEnum>("generation_type"))
 {
   std::vector<MooseEnum> domains;
   std::vector<MooseEnum> types;
  
   if (_series_type_name == "Cartesian")
   {
     /*
      * For Cartesian series, at least one of 'x', 'y', and 'z' must be specified.
      *
      * The individual series are always stored in x, y, z order (independent of the order in which
      * they appear in the input file). Hence, the 'orders' and 'physical_bounds' vectors must always
      * be specified in x, y, z order.
      */
     if (isParamValid("x"))
     {
       domains.push_back(FunctionalBasisInterface::_domain_options = "x");
       types.push_back(_x);
     }
     if (isParamValid("y"))
     {
       domains.push_back(FunctionalBasisInterface::_domain_options = "y");
       types.push_back(_y);
     }
     if (isParamValid("z"))
     {
       domains.push_back(FunctionalBasisInterface::_domain_options = "z");
       types.push_back(_z);
     }
     if (types.size() == 0)
       mooseError("Must specify one of 'x', 'y', or 'z' for 'Cartesian' series!");
     _series_type = libmesh_make_unique<Cartesian>(
         domains, _orders, types, name(), _expansion_type, _generation_type);
   }
   else if (_series_type_name == "CylindricalDuo")
   {
     /*
      * CylindricalDuo represents a disc-axial expansion, where the disc is described by a single
      * series, such as Zernike (as opposed to a series individually representing r and a second
      * series independently representing theta. For CylindricalDuo series, the series are always
      * stored in the axial, planar order, independent of which order the series appear in the input
      * file. Therefore, the _orders and _physical_bounds vectors must always appear in axial, planar
      * order. The first entry in _domains is interpreted as the axial direction, and the following
      * two as the planar.
      */
     if (isParamValid("x"))
     {
       domains = {FunctionalBasisInterface::_domain_options = "x",
                  FunctionalBasisInterface::_domain_options = "y",
                  FunctionalBasisInterface::_domain_options = "z"};
       types.push_back(_x);
     }
     if (isParamValid("y"))
     {
       domains = {FunctionalBasisInterface::_domain_options = "y",
                  FunctionalBasisInterface::_domain_options = "x",
                  FunctionalBasisInterface::_domain_options = "z"};
       types.push_back(_y);
     }
     if (isParamValid("z"))
     {
       domains = {FunctionalBasisInterface::_domain_options = "z",
                  FunctionalBasisInterface::_domain_options = "x",
                  FunctionalBasisInterface::_domain_options = "y"};
       types.push_back(_z);
     }
  
     if (types.size() == 0)
       mooseError("Must specify one of 'x', 'y', or 'z' for 'CylindricalDuo' series!");
  
     if (types.size() > 1)
       mooseError("Cannot specify more than one of 'x', 'y', or 'z' for 'CylindricalDuo' series!");
  
     types.push_back(_disc);
     _series_type = libmesh_make_unique<CylindricalDuo>(
         domains, _orders, types, name(), _expansion_type, _generation_type);
   }
   else
     mooseError("Unknown functional series type \"", _series_type_name, "\"");
  
   // Set the physical bounds of each of the single series if defined
   if (isParamValid("physical_bounds"))
     _series_type->setPhysicalBounds(_physical_bounds);
  
   // Resize the coefficient array as needed
   enforceSize(false), resize(getNumberOfTerms(), 0.0), enforceSize(true);
   setCharacteristics(_orders);
 }

Member Function Documentation

◆ checkAndConvertFunction()

FunctionSeries & FunctionSeries::checkAndConvertFunction	(	const Function &	function,
		const std::string &	typeName,
		const std::string &	objectName
	)

static

Static function to cast a Function to SeriesFunction.

Definition at line 175 of file FunctionSeries.C.

 {
   const FunctionSeries * test = dynamic_cast<const FunctionSeries *>(&function);
   if (!test)
     ::mooseError("In ",
                  typeName,
                  "-type object \"",
                  objectName,
                  "\": the named Function \"",
                  function.name(),
                  "\" must be a FunctionSeries-type object.");
  
   return *const_cast<FunctionSeries *>(test);
 }

Referenced by FunctionSeriesToAux::FunctionSeriesToAux(), FXFluxBC::FXFluxBC(), FXValueBC::FXValueBC(), and FXValuePenaltyBC::FXValuePenaltyBC().

◆ coefficientsChanged()

void MutableCoefficientsFunctionInterface::coefficientsChanged ( )

overrideprotectedvirtualinherited

Called when the coefficients have been changed.

Reimplemented from MutableCoefficientsInterface.

Definition at line 39 of file MutableCoefficientsFunctionInterface.C.

 {
   // The coefficients have changed, which invalidates the cache
   invalidateCache();
 }

◆ convertOrders()

std::vector< std::size_t > FunctionSeries::convertOrders ( const std::vector< unsigned int > & orders )

staticprivate

Static function to convert an array of unsigned int to std::size_t.

The MOOSE parser has issues reading a list of integers in as std::size_t (unsigned long), so this workaround is required in order to set _orders in the constructor initializer list.

Definition at line 290 of file FunctionSeries.C.

 {
   return std::vector<std::size_t>(orders.begin(), orders.end());
 }

◆ enforceSize()

void MutableCoefficientsInterface::enforceSize ( bool enforce )

inherited

Toggle whether the size of the coefficient array can be changed.

Definition at line 111 of file MutableCoefficientsInterface.C.

 {
   _enforce_size = enforce;
 }

Referenced by FunctionSeries(), and MutableCoefficientsFunctionInterface::MutableCoefficientsFunctionInterface().

◆ evaluateValue()

Real FunctionSeries::evaluateValue	(	Real	time,
		const Point &	point
	)

overridevirtual

Used in derived classes, equivalent to Function::value()

Implements MemoizedFunctionInterface.

Definition at line 250 of file FunctionSeries.C.

 {
   // Check that the point is within the physical bounds of the series
   if (!isInPhysicalBounds(point))
     return 0.0;
  
   // Set the location at which to evaluate the series
   setLocation(point);
  
   return expand();
 }

◆ expand() [1/2]

Real FunctionSeries::expand ( )

Expand the function series at the current location and with the current coefficients.

Definition at line 263 of file FunctionSeries.C.

 {
   return expand(_coefficients);
 }

Referenced by evaluateValue().

◆ expand() [2/2]

Real FunctionSeries::expand ( const std::vector< Real > & coefficients )

Expand the function using the provided coefficients at the current location.

Definition at line 269 of file FunctionSeries.C.

 {
   // Evaluate all of the terms in the series
   const std::vector<Real> & terms = getExpansion();
  
   return std::inner_product(terms.begin(), terms.end(), coefficients.begin(), 0.0);
 }

◆ getCharacteristics()

const std::vector< std::size_t > & MutableCoefficientsInterface::getCharacteristics ( ) const

inherited

Get a reference to the characteristics array.

Definition at line 51 of file MutableCoefficientsInterface.C.

 {
   return _characteristics;
 }

◆ getCoefficients() [1/2]

std::vector< Real > & MutableCoefficientsInterface::getCoefficients ( )

inherited

Get a writeable reference to the vector of coefficients.

Definition at line 63 of file MutableCoefficientsInterface.C.

 {
   return _coefficients;
 }

◆ getCoefficients() [2/2]

const std::vector< Real > & MutableCoefficientsInterface::getCoefficients ( ) const

inherited

Get a read-only reference to the vector of coefficients.

Definition at line 57 of file MutableCoefficientsInterface.C.

 {
   return _coefficients;
 }

◆ getCoefficientsTable()

std::string MutableCoefficientsInterface::getCoefficientsTable ( ) const

inherited

Get a formatted string of the coefficients.

Definition at line 69 of file MutableCoefficientsInterface.C.

 {
   std::stringbuf string;
   std::ostream table(&string);
  
   table << *this;
  
   return string.str();
 }

◆ getExpansion()

const std::vector< Real > & FunctionSeries::getExpansion ( )

Returns a vector of the expansion-evaluated functional series at the current location.

Definition at line 227 of file FunctionSeries.C.

 {
   return _series_type->getAllExpansion();
 }

Referenced by expand().

◆ getGeneration()

const std::vector< Real > & FunctionSeries::getGeneration ( )

Returns a vector of the generation-evaluated functional series at the current location.

Definition at line 216 of file FunctionSeries.C.

 {
   return _series_type->getAllGeneration();
 }

◆ getNumberOfTerms()

std::size_t FunctionSeries::getNumberOfTerms ( ) const

Returns the number of terms (coefficients) in the underlying function series.

Definition at line 199 of file FunctionSeries.C.

 {
   return _series_type->getNumberOfTerms();
 }

Referenced by FunctionSeries(), FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::FXIntegralBaseUserObject(), and operator<<().

◆ getOrders()

const std::vector< size_t > & FunctionSeries::getOrders ( ) const

Returns a vector of the functional orders in the underlying functional series.

Definition at line 205 of file FunctionSeries.C.

 {
   return _orders;
 }

Referenced by FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::FXIntegralBaseUserObject().

◆ getSize()

std::size_t MutableCoefficientsInterface::getSize ( ) const

inherited

Get the size, aka number of coefficients.

Definition at line 80 of file MutableCoefficientsInterface.C.

 {
   return _coefficients.size();
 }

Referenced by MutableCoefficientsInterface::isCompatibleWith(), and operator<<().

◆ getStandardizedFunctionVolume()

Real FunctionSeries::getStandardizedFunctionVolume ( ) const

Returns the volume of evaluation in the functional series standardized space.

Definition at line 193 of file FunctionSeries.C.

 {
   return _series_type->getStandardizedFunctionVolume();
 }

◆ importCoefficients()

void MutableCoefficientsInterface::importCoefficients ( const MutableCoefficientsInterface & other )

inherited

Import the coefficients from another instance.

Definition at line 117 of file MutableCoefficientsInterface.C.

 {
   if (!isCompatibleWith(other))
     mooseError("Cannot import coefficients from incompatible MutableCoefficientsInterface");
  
   _coefficients = other._coefficients;
  
   if (_print_coefficients)
     _console << *this;
  
   coefficientsChanged();
 }

Referenced by MultiAppFXTransfer::execute().

◆ invalidateCache()

void MemoizedFunctionInterface::invalidateCache ( )

protectedinherited

Called by derived classes to invalidate the cache, perhaps due to a state change.

Definition at line 84 of file MemoizedFunctionInterface.C.

 {
   _cache.clear();
 }

Referenced by MutableCoefficientsFunctionInterface::coefficientsChanged(), MemoizedFunctionInterface::meshChanged(), MemoizedFunctionInterface::useCache(), and MemoizedFunctionInterface::value().

◆ isCompatibleWith()

bool MutableCoefficientsInterface::isCompatibleWith ( const MutableCoefficientsInterface & other ) const

inherited

Checks to see if another instance is compatible.

Definition at line 86 of file MutableCoefficientsInterface.C.

 {
   // Check the coefficient sizes if requested
   if ((_enforce_size && other._enforce_size) && getSize() != other.getSize())
     return false;
  
   // Check the size of the characteristics array
   if (_characteristics.size() != other._characteristics.size())
     return false;
  
   // Check the values of the characteristics array
   for (std::size_t i = 0; i < _characteristics.size(); ++i)
     if (_characteristics[i] != other._characteristics[i])
       return false;
  
   return true;
 }

Referenced by MultiAppFXTransfer::execute(), and MutableCoefficientsInterface::importCoefficients().

◆ isInPhysicalBounds()

bool FunctionSeries::isInPhysicalBounds ( const Point & point ) const

Returns true if the provided point is within the set physical boundaries.

Definition at line 238 of file FunctionSeries.C.

 {
   return _series_type->isInPhysicalBounds(point);
 }

Referenced by evaluateValue().

◆ isSizeEnforced()

bool MutableCoefficientsInterface::isSizeEnforced ( ) const

inherited

Returns true if the size of the coefficient array is fixed and enforced.

Definition at line 105 of file MutableCoefficientsInterface.C.

 {
   return _enforce_size;
 }

◆ meshChanged()

void MemoizedFunctionInterface::meshChanged ( )

overridevirtualinherited

Definition at line 40 of file MemoizedFunctionInterface.C.

 {
   // The mesh has changed, which invalidates the cache
   invalidateCache();
 }

◆ operator[]()

Real MutableCoefficientsInterface::operator[] ( std::size_t index ) const

inherited

Get the value of the coefficient at the corresponding index.

Definition at line 45 of file MutableCoefficientsInterface.C.

 {
   return _coefficients[index];
 }

◆ resize()

void MutableCoefficientsInterface::resize	(	std::size_t	size,
		Real	fill = `0.0`,
		bool	fill_out_to_size = `true`
	)

inherited

Resize the array, using the value for fill if the new size is larger.

Definition at line 131 of file MutableCoefficientsInterface.C.

 {
   if (size != _coefficients.size())
   {
     if (_enforce_size &&
         (size > _coefficients.size() || (size < _coefficients.size() && !fill_out_to_size)))
       mooseError("Cannot resize coefficient array with size enforcement enabled.");
  
     _coefficients.resize(size, fill);
  
     if (_print_coefficients)
       _console << *this;
  
     coefficientsChanged();
   }
 }

Referenced by FunctionSeries().

◆ setCharacteristics()

void MutableCoefficientsInterface::setCharacteristics ( const std::vector< std::size_t > & new_characteristics )

inherited

Sets the characteristics array.

Definition at line 149 of file MutableCoefficientsInterface.C.

 {
   _characteristics = new_characteristics;
 }

Referenced by FunctionSeries().

◆ setCoefficients() [1/2]

void MutableCoefficientsInterface::setCoefficients ( const std::vector< Real > & new_coefficients )

inherited

Set the coefficients using a copy operation.

Definition at line 156 of file MutableCoefficientsInterface.C.

 {
   if (_enforce_size && new_coefficients.size() != _coefficients.size())
     mooseError("Cannon assigned a coefficient array with differing size when size enforcement is "
                "enabled.");
  
   _coefficients = new_coefficients;
  
   if (_print_coefficients)
     _console << *this;
  
   coefficientsChanged();
 }

Referenced by MutableCoefficientsFunctionInterface::MutableCoefficientsFunctionInterface().

◆ setCoefficients() [2/2]

void MutableCoefficientsInterface::setCoefficients ( std::vector< Real > && dropin_coefficients )

inherited

Set the coefficients using a move operation (only works with temp objects)

Definition at line 171 of file MutableCoefficientsInterface.C.

 {
   if (_enforce_size && dropin_coefficients.size() != _coefficients.size())
     mooseError("Cannon assigned a coefficient array with differing size when size enforcement is "
                "enabled.");
  
   _coefficients = dropin_coefficients;
  
   if (_print_coefficients)
     _console << *this;
  
   coefficientsChanged();
 }

◆ setLocation()

void FunctionSeries::setLocation ( const Point & point )

Set the current evaluation location.

Definition at line 244 of file FunctionSeries.C.

 {
   _series_type->setLocation(point);
 }

Referenced by evaluateValue().

◆ useCache()

void MemoizedFunctionInterface::useCache ( bool use )

inherited

Enable/disable the cache.

Definition at line 75 of file MemoizedFunctionInterface.C.

 {
   _enable_cache = use;
  
   if (!_enable_cache)
     invalidateCache();
 }

Referenced by FXFluxBC::FXFluxBC(), FXValueBC::FXValueBC(), and FXValuePenaltyBC::FXValuePenaltyBC().

◆ value()

Real MemoizedFunctionInterface::value	(	Real	time,
		const Point &	point
	)		const

finalvirtualinherited

Definition at line 47 of file MemoizedFunctionInterface.C.

 {
   MemoizedFunctionInterface * ptr = const_cast<MemoizedFunctionInterface *>(this);
  
   if (_enable_cache)
   {
     // Start the cache over if we are at a new time step
     if (_respect_time && time != _current_time)
     {
       _current_time = time;
       ptr->invalidateCache();
     }
  
     // Try to insert a new value into the cache
     auto result = _cache.insert({hashing::hashCombine(time, point), 0.0});
  
     // Evaluate and apply if the insertion worked, i.e. the element didn't exist
     if (result.second)
       result.first->second = ptr->evaluateValue(time, point);
  
     // Return the cached value
     return result.first->second;
   }
  
   return ptr->evaluateValue(time, point);
 }

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	stream,
		const FunctionSeries &	me
	)

friend

Returns a tabularized text stream of the currently stored coefficients.

Definition at line 278 of file FunctionSeries.C.

 {
   stream << "\n\n"
          << "FunctionSeries: " << me.name() << "\n"
          << "         Terms: " << me.getNumberOfTerms() << "\n";
   me._series_type->formatCoefficients(stream, me._coefficients);
   stream << "\n\n";
  
   return stream;
 }

Member Data Documentation

◆ _cache

std::unordered_map<hashing::HashValue, Real> MemoizedFunctionInterface::_cache

mutableprivateinherited

Cached evaluations for each point.

Definition at line 59 of file MemoizedFunctionInterface.h.

Referenced by MemoizedFunctionInterface::invalidateCache(), and MemoizedFunctionInterface::value().

◆ _characteristics

std::vector<std::size_t>& MutableCoefficientsInterface::_characteristics

protectedinherited

An array of integer characteristics that can be used to check compatibility.

Definition at line 107 of file MutableCoefficientsInterface.h.

Referenced by FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::FXIntegralBaseUserObject(), MutableCoefficientsInterface::getCharacteristics(), MutableCoefficientsInterface::isCompatibleWith(), and MutableCoefficientsInterface::setCharacteristics().

◆ _coefficients

std::vector<Real>& MutableCoefficientsInterface::_coefficients

protectedinherited

The coefficient array.

Definition at line 113 of file MutableCoefficientsInterface.h.

Referenced by expand(), FXIntegralBaseUserObject< ElementIntegralVariableUserObject >::FXIntegralBaseUserObject(), MutableCoefficientsInterface::getCoefficients(), MutableCoefficientsInterface::getSize(), MutableCoefficientsInterface::importCoefficients(), operator<<(), MutableCoefficientsInterface::operator[](), MutableCoefficientsInterface::resize(), and MutableCoefficientsInterface::setCoefficients().

◆ _console

const ConsoleStream& MutableCoefficientsInterface::_console

privateinherited

MooseObject instance of this to provide access to _console

Definition at line 123 of file MutableCoefficientsInterface.h.

Referenced by MutableCoefficientsInterface::importCoefficients(), MutableCoefficientsInterface::resize(), and MutableCoefficientsInterface::setCoefficients().

◆ _current_time

Real MemoizedFunctionInterface::_current_time

mutableprivateinherited

Stores the time evaluation of the cache.

Definition at line 62 of file MemoizedFunctionInterface.h.

Referenced by MemoizedFunctionInterface::value().

◆ _disc

const MooseEnum& FunctionSeries::_disc

protected

Stores the name of the single function series to use for a unit disc.

Definition at line 114 of file FunctionSeries.h.

Referenced by FunctionSeries().

◆ _enable_cache

bool MemoizedFunctionInterface::_enable_cache

privateinherited

Flag for whether to cache values.

Definition at line 65 of file MemoizedFunctionInterface.h.

Referenced by MemoizedFunctionInterface::useCache(), and MemoizedFunctionInterface::value().

◆ _enforce_size

bool MutableCoefficientsInterface::_enforce_size

protectedinherited

Boolean that locks or allows resizing of the coefficient array.

Definition at line 116 of file MutableCoefficientsInterface.h.

Referenced by MutableCoefficientsInterface::enforceSize(), MutableCoefficientsInterface::isCompatibleWith(), MutableCoefficientsInterface::isSizeEnforced(), MutableCoefficientsInterface::resize(), and MutableCoefficientsInterface::setCoefficients().

◆ _expansion_type

const MooseEnum& FunctionSeries::_expansion_type

protected

The normalization type for expansion.

Definition at line 116 of file FunctionSeries.h.

Referenced by FunctionSeries().

◆ _generation_type

const MooseEnum& FunctionSeries::_generation_type

protected

The normalization type for generation.

Definition at line 118 of file FunctionSeries.h.

Referenced by FunctionSeries().

◆ _orders

const std::vector<std::size_t> FunctionSeries::_orders

protected

The vector holding the orders of each single series.

Definition at line 92 of file FunctionSeries.h.

Referenced by FunctionSeries(), and getOrders().

◆ _physical_bounds

const std::vector<Real> FunctionSeries::_physical_bounds

protected

The physical bounds of the function series.

Definition at line 95 of file FunctionSeries.h.

Referenced by FunctionSeries().

◆ _print_coefficients

const bool MutableCoefficientsInterface::_print_coefficients

protectedinherited

Boolean to flag if the coefficients should be printed when set.

Definition at line 119 of file MutableCoefficientsInterface.h.

Referenced by MutableCoefficientsInterface::importCoefficients(), MutableCoefficientsInterface::resize(), and MutableCoefficientsInterface::setCoefficients().

◆ _respect_time

bool MemoizedFunctionInterface::_respect_time

privateinherited

Flag for whether changes in time invalidate the cache.

Definition at line 68 of file MemoizedFunctionInterface.h.

Referenced by MemoizedFunctionInterface::value().

◆ _series_type

std::unique_ptr<CompositeSeriesBasisInterface> FunctionSeries::_series_type

protected

Stores a pointer to the functional series object.

Definition at line 98 of file FunctionSeries.h.

Referenced by FunctionSeries(), getExpansion(), getGeneration(), getNumberOfTerms(), getStandardizedFunctionVolume(), isInPhysicalBounds(), operator<<(), and setLocation().

◆ _series_type_name

const MooseEnum& FunctionSeries::_series_type_name

protected

Stores the name of the current functional series type.

Definition at line 101 of file FunctionSeries.h.

Referenced by FunctionSeries().

◆ _x

const MooseEnum& FunctionSeries::_x

protected

Stores the name of the single function series to use in the x direction.

Definition at line 108 of file FunctionSeries.h.

Referenced by FunctionSeries().

◆ _y

const MooseEnum& FunctionSeries::_y

protected

Stores the name of the single function series to use in the y direction.

Definition at line 110 of file FunctionSeries.h.

Referenced by FunctionSeries().

◆ _z

const MooseEnum& FunctionSeries::_z

protected

Stores the name of the single function series to use in the z direction.

Definition at line 112 of file FunctionSeries.h.

Referenced by FunctionSeries().

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

functional_expansion_tools/include/functions/FunctionSeries.h
functional_expansion_tools/src/functions/FunctionSeries.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ FunctionSeries()

Member Function Documentation

◆ checkAndConvertFunction()

◆ coefficientsChanged()

◆ convertOrders()

◆ enforceSize()

◆ evaluateValue()

◆ expand() [1/2]

◆ expand() [2/2]

◆ getCharacteristics()

◆ getCoefficients() [1/2]

◆ getCoefficients() [2/2]

◆ getCoefficientsTable()

◆ getExpansion()

◆ getGeneration()

◆ getNumberOfTerms()

◆ getOrders()

◆ getSize()

◆ getStandardizedFunctionVolume()

◆ importCoefficients()

◆ invalidateCache()

◆ isCompatibleWith()

◆ isInPhysicalBounds()

◆ isSizeEnforced()

◆ meshChanged()

◆ operator[]()

◆ resize()

◆ setCharacteristics()

◆ setCoefficients() [1/2]

◆ setCoefficients() [2/2]

◆ setLocation()

◆ useCache()

◆ value()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ _cache

◆ _characteristics

◆ _coefficients

◆ _console

◆ _current_time

◆ _disc

◆ _enable_cache

◆ _enforce_size

◆ _expansion_type

◆ _generation_type

◆ _orders

◆ _physical_bounds

◆ _print_coefficients

◆ _respect_time

◆ _series_type

◆ _series_type_name

◆ _x

◆ _y

◆ _z