This class provides the basis for any custom functional basis, and is the parent class of both SingleSeriesBasisInterface and CompositeSeriesBasisInterface. More...

#include <FunctionalBasisInterface.h>

Inheritance diagram for FunctionalBasisInterface:

[legend]

Public Member Functions
	FunctionalBasisInterface ()

	FunctionalBasisInterface (const unsigned int number_of_terms)

Real	operator[] (std::size_t index) const
	Returns the current evaluation at the given index.

const std::vector< Real > &	getAllGeneration ()
	Returns an array reference containing the value of each generation term.

const std::vector< Real > &	getAllExpansion ()
	Returns an array reference containing the value of each expansion term.

std::size_t	getNumberOfTerms () const
	Returns the number of terms in the series.

Real	getGeneration ()
	Gets the last term of the generation functional basis.

Real	getGenerationSeriesSum ()
	Gets the sum of all terms in the generation functional basis.

Real	getExpansion ()
	Gets the #_order-th term of the expansion functional basis.

Real	getExpansionSeriesSum ()
	Evaluates the sum of all terms in the expansion functional basis up to #_order.

virtual const std::vector< Real > &	getStandardizedFunctionLimits () const =0
	Returns a vector of the lower and upper bounds of the standard functional space.

virtual Real	getStandardizedFunctionVolume () const =0
	Returns the volume within the standardized function local_limits.

bool	isGeneration () const
	Returns true if the current evaluation is generation.

bool	isExpansion () const
	Returns true if the current evaluation is expansion.

virtual bool	isCacheInvalid () const =0
	Whether the cached values correspond to the current point.

virtual bool	isInPhysicalBounds (const Point &point) const =0
	Determines if the point provided is in within the physical bounds.

virtual void	setLocation (const Point &point)=0
	Set the location that will be used by the series to compute values.

virtual void	setOrder (const std::vector< std::size_t > &orders)=0
	Set the order of the series.

virtual void	setPhysicalBounds (const std::vector< Real > &bounds)=0
	Sets the bounds of the series.

Static Public Attributes
static MooseEnum	_domain_options
	An enumeration of the domains available to each functional series.

Protected Member Functions
virtual void	clearBasisEvaluation (const unsigned int &number_of_terms)
	Set all entries of the basis evaluation to zero.

virtual void	evaluateGeneration ()=0
	Evaluate the generation form of the functional basis.

virtual void	evaluateExpansion ()=0
	Evaluate the expansion form of the functional basis.

Real	load (std::size_t index) const
	Helper function to load a value from #_series.

void	save (std::size_t index, Real value)
	Helper function to store a value in #_series.

Protected Attributes
unsigned int	_number_of_terms
	The number of terms in the series.

bool	_is_cache_invalid
	indicates if the evaluated values correspond to the current location

Private Attributes
std::vector< Real >	_basis_evaluation
	Stores the values of the basis evaluation.

bool	_is_generation
	Indicates whether the current evaluation is expansion or generation.

Detailed Description

This class provides the basis for any custom functional basis, and is the parent class of both SingleSeriesBasisInterface and CompositeSeriesBasisInterface.

Definition at line 22 of file FunctionalBasisInterface.h.

Constructor & Destructor Documentation

◆ FunctionalBasisInterface() [1/2]

FunctionalBasisInterface::FunctionalBasisInterface ( )

Definition at line 20 of file FunctionalBasisInterface.C.

  : _is_cache_invalid(true), _is_generation(false)
{
}

◆ FunctionalBasisInterface() [2/2]

FunctionalBasisInterface::FunctionalBasisInterface ( const unsigned int number_of_terms )

Definition at line 29 of file FunctionalBasisInterface.C.

  : _number_of_terms(number_of_terms),
    _is_cache_invalid(true),
    _basis_evaluation(_number_of_terms, 0.0),
    _is_generation(false)
{
  _basis_evaluation.shrink_to_fit();
}

Member Function Documentation

◆ clearBasisEvaluation()

void FunctionalBasisInterface::clearBasisEvaluation ( const unsigned int & number_of_terms )

protectedvirtual

Set all entries of the basis evaluation to zero.

Reimplemented in CompositeSeriesBasisInterface, and SingleSeriesBasisInterface.

Definition at line 145 of file FunctionalBasisInterface.C.

{
  _basis_evaluation.assign(number_of_terms, 0.0);
  _basis_evaluation.shrink_to_fit();
}

Referenced by getAllExpansion(), and getAllGeneration().

◆ evaluateExpansion()

virtual void FunctionalBasisInterface::evaluateExpansion ( )

protectedpure virtual

Evaluate the expansion form of the functional basis.

Implemented in CompositeSeriesBasisInterface, and SingleSeriesBasisInterface.

Referenced by getAllExpansion().

◆ evaluateGeneration()

virtual void FunctionalBasisInterface::evaluateGeneration ( )

protectedpure virtual

Evaluate the generation form of the functional basis.

Implemented in CompositeSeriesBasisInterface, and SingleSeriesBasisInterface.

Referenced by getAllGeneration().

◆ getAllExpansion()

const std::vector< Real > & FunctionalBasisInterface::getAllExpansion ( )

Returns an array reference containing the value of each expansion term.

Definition at line 73 of file FunctionalBasisInterface.C.

{
  if (isGeneration() || isCacheInvalid())
  {
    clearBasisEvaluation(_number_of_terms);
 
    evaluateExpansion();
 
    _is_generation = false;
    _is_cache_invalid = false;
  }
 
  return _basis_evaluation;
}

Referenced by getExpansion(), and getExpansionSeriesSum().

◆ getAllGeneration()

const std::vector< Real > & FunctionalBasisInterface::getAllGeneration ( )

Returns an array reference containing the value of each generation term.

Definition at line 57 of file FunctionalBasisInterface.C.

{
  if (isExpansion() || isCacheInvalid())
  {
    clearBasisEvaluation(_number_of_terms);
 
    evaluateGeneration();
 
    _is_generation = true;
    _is_cache_invalid = false;
  }
 
  return _basis_evaluation;
}

Referenced by getGeneration(), and getGenerationSeriesSum().

◆ getExpansion()

Real FunctionalBasisInterface::getExpansion ( )

Gets the #_order-th term of the expansion functional basis.

Definition at line 114 of file FunctionalBasisInterface.C.

{
  // Use getAllExpansion() which will lazily evaluate the series as needed
  return getAllExpansion().back();
}

◆ getExpansionSeriesSum()

Real FunctionalBasisInterface::getExpansionSeriesSum ( )

Evaluates the sum of all terms in the expansion functional basis up to #_order.

Definition at line 121 of file FunctionalBasisInterface.C.

{
  Real sum = 0.0;
 
  // Use getAllExpansion() which will lazily evaluate the series as needed
  for (auto term : getAllExpansion())
    sum += term;
 
  return sum;
}

Referenced by TEST(), and TEST().

◆ getGeneration()

Real FunctionalBasisInterface::getGeneration ( )

Gets the last term of the generation functional basis.

Definition at line 95 of file FunctionalBasisInterface.C.

{
  // Use getAllGeneration() which will lazily evaluate the series as needed
  return getAllGeneration().back();
}

◆ getGenerationSeriesSum()

Real FunctionalBasisInterface::getGenerationSeriesSum ( )

Gets the sum of all terms in the generation functional basis.

Definition at line 102 of file FunctionalBasisInterface.C.

{
  Real sum = 0.0;
 
  // Use getAllGeneration() which will lazily evaluate the series as needed
  for (auto term : getAllGeneration())
    sum += term;
 
  return sum;
}

Referenced by TEST(), and TEST().

◆ getNumberOfTerms()

std::size_t FunctionalBasisInterface::getNumberOfTerms ( ) const

Returns the number of terms in the series.

Definition at line 89 of file FunctionalBasisInterface.C.

{
  return _number_of_terms;
}

Referenced by Legendre::evaluateSqrtMu(), TEST(), TEST(), TEST(), and TEST().

◆ getStandardizedFunctionLimits()

virtual const std::vector< Real > & FunctionalBasisInterface::getStandardizedFunctionLimits ( ) const

pure virtual

Returns a vector of the lower and upper bounds of the standard functional space.

Implemented in CompositeSeriesBasisInterface, Legendre, and Zernike.

◆ getStandardizedFunctionVolume()

virtual Real FunctionalBasisInterface::getStandardizedFunctionVolume ( ) const

pure virtual

Returns the volume within the standardized function local_limits.

Implemented in CompositeSeriesBasisInterface, Legendre, and Zernike.

◆ isCacheInvalid()

virtual bool FunctionalBasisInterface::isCacheInvalid ( ) const

pure virtual

Whether the cached values correspond to the current point.

Implemented in CompositeSeriesBasisInterface, and SingleSeriesBasisInterface.

Referenced by getAllExpansion(), and getAllGeneration().

◆ isExpansion()

bool FunctionalBasisInterface::isExpansion ( ) const

Returns true if the current evaluation is expansion.

Definition at line 51 of file FunctionalBasisInterface.C.

{
  return !_is_generation;
}

Referenced by getAllGeneration().

◆ isGeneration()

bool FunctionalBasisInterface::isGeneration ( ) const

Returns true if the current evaluation is generation.

Definition at line 45 of file FunctionalBasisInterface.C.

{
  return _is_generation;
}

Referenced by getAllExpansion().

◆ isInPhysicalBounds()

virtual bool FunctionalBasisInterface::isInPhysicalBounds ( const Point & point ) const

pure virtual

Determines if the point provided is in within the physical bounds.

Implemented in CompositeSeriesBasisInterface, Legendre, and Zernike.

◆ load()

Real FunctionalBasisInterface::load ( std::size_t index ) const

protected

Helper function to load a value from #_series.

Definition at line 133 of file FunctionalBasisInterface.C.

{
  return _basis_evaluation[index];
}

Referenced by Legendre::evaluateOrthonormal(), Zernike::evaluateOrthonormal(), Legendre::evaluateSqrtMu(), Zernike::evaluateSqrtMu(), Legendre::evaluateStandard(), Zernike::evaluateStandard(), and Zernike::fillOutNegativeRankAndApplyAzimuthalComponent().

◆ operator[]()

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

Returns the current evaluation at the given index.

Definition at line 39 of file FunctionalBasisInterface.C.

{
  return (index > _basis_evaluation.size() ? 0.0 : _basis_evaluation[index]);
}

◆ save()

void FunctionalBasisInterface::save	(	std::size_t	index,
		Real	value
	)

protected

Helper function to store a value in #_series.

Definition at line 139 of file FunctionalBasisInterface.C.

{
  _basis_evaluation[index] = value;
}

Referenced by Legendre::evaluateOrthonormal(), Zernike::evaluateOrthonormal(), CompositeSeriesBasisInterface::evaluateSeries(), Legendre::evaluateSqrtMu(), Zernike::evaluateSqrtMu(), Legendre::evaluateStandard(), Zernike::evaluateStandard(), and Zernike::fillOutNegativeRankAndApplyAzimuthalComponent().

◆ setLocation()

virtual void FunctionalBasisInterface::setLocation ( const Point & point )

pure virtual

Set the location that will be used by the series to compute values.

Implemented in CompositeSeriesBasisInterface, and SingleSeriesBasisInterface.

◆ setOrder()

virtual void FunctionalBasisInterface::setOrder ( const std::vector< std::size_t > & orders )

pure virtual

Set the order of the series.

Implemented in CompositeSeriesBasisInterface, and SingleSeriesBasisInterface.

◆ setPhysicalBounds()

virtual void FunctionalBasisInterface::setPhysicalBounds ( const std::vector< Real > & bounds )

pure virtual

Sets the bounds of the series.

Implemented in Cartesian, CylindricalDuo, and SingleSeriesBasisInterface.

Member Data Documentation

◆ _basis_evaluation

std::vector<Real> FunctionalBasisInterface::_basis_evaluation

private

Stores the values of the basis evaluation.

Definition at line 150 of file FunctionalBasisInterface.h.

Referenced by clearBasisEvaluation(), FunctionalBasisInterface(), getAllExpansion(), getAllGeneration(), load(), operator[](), and save().

◆ _domain_options

MooseEnum FunctionalBasisInterface::_domain_options

static

An enumeration of the domains available to each functional series.

Definition at line 114 of file FunctionalBasisInterface.h.

Referenced by FunctionSeries::FunctionSeries(), SingleSeriesBasisInterface::SingleSeriesBasisInterface(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), and TEST().

◆ _is_cache_invalid

bool FunctionalBasisInterface::_is_cache_invalid

protected

indicates if the evaluated values correspond to the current location

Definition at line 146 of file FunctionalBasisInterface.h.

Referenced by getAllExpansion(), and getAllGeneration().

◆ _is_generation

bool FunctionalBasisInterface::_is_generation

private

Indicates whether the current evaluation is expansion or generation.

Definition at line 153 of file FunctionalBasisInterface.h.

Referenced by getAllExpansion(), getAllGeneration(), isExpansion(), and isGeneration().

◆ _number_of_terms

unsigned int FunctionalBasisInterface::_number_of_terms

protected

The number of terms in the series.

Definition at line 143 of file FunctionalBasisInterface.h.

Referenced by getAllExpansion(), getAllGeneration(), getNumberOfTerms(), CompositeSeriesBasisInterface::setNumberOfTerms(), and SingleSeriesBasisInterface::setOrder().

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

functional_expansion_tools/include/series/FunctionalBasisInterface.h
functional_expansion_tools/src/series/FunctionalBasisInterface.C

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FunctionalBasisInterface() [1/2]

◆ FunctionalBasisInterface() [2/2]

Member Function Documentation

◆ clearBasisEvaluation()

◆ evaluateExpansion()

◆ evaluateGeneration()

◆ getAllExpansion()

◆ getAllGeneration()

◆ getExpansion()

◆ getExpansionSeriesSum()

◆ getGeneration()

◆ getGenerationSeriesSum()

◆ getNumberOfTerms()

◆ getStandardizedFunctionLimits()

◆ getStandardizedFunctionVolume()

◆ isCacheInvalid()

◆ isExpansion()

◆ isGeneration()

◆ isInPhysicalBounds()

◆ load()

◆ operator[]()

◆ save()

◆ setLocation()

◆ setOrder()

◆ setPhysicalBounds()

Member Data Documentation

◆ _basis_evaluation

◆ _domain_options

◆ _is_cache_invalid

◆ _is_generation

◆ _number_of_terms