This class provides the basis for any custom functional basis, and is the parent class of both SingleSeriesBasisInterface and CompositeSeriesBasisInterface. More...
#include <FunctionalBasisInterface.h>
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. More... | |
const std::vector< Real > & | getAllGeneration () |
Returns an array reference containing the value of each generation term. More... | |
const std::vector< Real > & | getAllExpansion () |
Returns an array reference containing the value of each expansion term. More... | |
std::size_t | getNumberOfTerms () const |
Returns the number of terms in the series. More... | |
Real | getGeneration () |
Gets the last term of the generation functional basis. More... | |
Real | getGenerationSeriesSum () |
Gets the sum of all terms in the generation functional basis. More... | |
Real | getExpansion () |
Gets the #_order-th term of the expansion functional basis. More... | |
Real | getExpansionSeriesSum () |
Evaluates the sum of all terms in the expansion functional basis up to #_order. More... | |
virtual const std::vector< Real > & | getStandardizedFunctionLimits () const =0 |
Returns a vector of the lower and upper bounds of the standard functional space. More... | |
virtual Real | getStandardizedFunctionVolume () const =0 |
Returns the volume within the standardized function local_limits. More... | |
bool | isGeneration () const |
Returns true if the current evaluation is generation. More... | |
bool | isExpansion () const |
Returns true if the current evaluation is expansion. More... | |
virtual bool | isCacheInvalid () const =0 |
Whether the cached values correspond to the current point. More... | |
virtual bool | isInPhysicalBounds (const Point &point) const =0 |
Determines if the point provided is in within the physical bounds. More... | |
virtual void | setLocation (const Point &point)=0 |
Set the location that will be used by the series to compute values. More... | |
virtual void | setOrder (const std::vector< std::size_t > &orders)=0 |
Set the order of the series. More... | |
virtual void | setPhysicalBounds (const std::vector< Real > &bounds)=0 |
Sets the bounds of the series. More... | |
Static Public Attributes | |
static MooseEnum | _domain_options |
An enumeration of the domains available to each functional series. More... | |
Protected Member Functions | |
virtual void | clearBasisEvaluation (const unsigned int &number_of_terms) |
Set all entries of the basis evaluation to zero. More... | |
virtual void | evaluateGeneration ()=0 |
Evaluate the generation form of the functional basis. More... | |
virtual void | evaluateExpansion ()=0 |
Evaluate the expansion form of the functional basis. More... | |
Real | load (std::size_t index) const |
Helper function to load a value from #_series. More... | |
void | save (std::size_t index, Real value) |
Helper function to store a value in #_series. More... | |
Protected Attributes | |
unsigned int | _number_of_terms |
The number of terms in the series. More... | |
bool | _is_cache_invalid |
indicates if the evaluated values correspond to the current location More... | |
Private Attributes | |
std::vector< Real > | _basis_evaluation |
Stores the values of the basis evaluation. More... | |
bool | _is_generation |
Indicates whether the current evaluation is expansion or generation. More... | |
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.
FunctionalBasisInterface::FunctionalBasisInterface | ( | ) |
Definition at line 20 of file FunctionalBasisInterface.C.
FunctionalBasisInterface::FunctionalBasisInterface | ( | const unsigned int | number_of_terms | ) |
Definition at line 29 of file FunctionalBasisInterface.C.
|
protectedvirtual |
Set all entries of the basis evaluation to zero.
Definition at line 145 of file FunctionalBasisInterface.C.
Referenced by getAllExpansion(), getAllGeneration(), CompositeSeriesBasisInterface::setNumberOfTerms(), and SingleSeriesBasisInterface::setOrder().
|
protectedpure virtual |
Evaluate the expansion form of the functional basis.
Implemented in CompositeSeriesBasisInterface, and SingleSeriesBasisInterface.
Referenced by getAllExpansion().
|
protectedpure virtual |
Evaluate the generation form of the functional basis.
Implemented in CompositeSeriesBasisInterface, and SingleSeriesBasisInterface.
Referenced by getAllGeneration().
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.
Referenced by getExpansion(), and getExpansionSeriesSum().
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.
Referenced by getGeneration(), and getGenerationSeriesSum().
Real FunctionalBasisInterface::getExpansion | ( | ) |
Gets the #_order-th term of the expansion functional basis.
Definition at line 114 of file FunctionalBasisInterface.C.
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.
Referenced by TEST().
Real FunctionalBasisInterface::getGeneration | ( | ) |
Gets the last term of the generation functional basis.
Definition at line 95 of file FunctionalBasisInterface.C.
Real FunctionalBasisInterface::getGenerationSeriesSum | ( | ) |
Gets the sum of all terms in the generation functional basis.
Definition at line 102 of file FunctionalBasisInterface.C.
Referenced by TEST().
std::size_t FunctionalBasisInterface::getNumberOfTerms | ( | ) | const |
Returns the number of terms in the series.
Definition at line 89 of file FunctionalBasisInterface.C.
Referenced by Legendre::evaluateSqrtMu(), and TEST().
|
pure virtual |
Returns a vector of the lower and upper bounds of the standard functional space.
Implemented in CompositeSeriesBasisInterface, Zernike, and Legendre.
|
pure virtual |
Returns the volume within the standardized function local_limits.
Implemented in CompositeSeriesBasisInterface, Zernike, and Legendre.
|
pure virtual |
Whether the cached values correspond to the current point.
Implemented in CompositeSeriesBasisInterface, and SingleSeriesBasisInterface.
Referenced by getAllExpansion(), and getAllGeneration().
bool FunctionalBasisInterface::isExpansion | ( | ) | const |
Returns true if the current evaluation is expansion.
Definition at line 51 of file FunctionalBasisInterface.C.
Referenced by getAllGeneration().
bool FunctionalBasisInterface::isGeneration | ( | ) | const |
Returns true if the current evaluation is generation.
Definition at line 45 of file FunctionalBasisInterface.C.
Referenced by getAllExpansion().
|
pure virtual |
Determines if the point provided is in within the physical bounds.
Implemented in CompositeSeriesBasisInterface, Zernike, and Legendre.
|
protected |
Helper function to load a value from #_series.
Definition at line 133 of file FunctionalBasisInterface.C.
Referenced by Legendre::evaluateOrthonormal(), Zernike::evaluateOrthonormal(), Legendre::evaluateSqrtMu(), Zernike::evaluateSqrtMu(), Legendre::evaluateStandard(), Zernike::evaluateStandard(), and Zernike::fillOutNegativeRankAndApplyAzimuthalComponent().
Real FunctionalBasisInterface::operator[] | ( | std::size_t | index | ) | const |
Returns the current evaluation at the given index.
Definition at line 39 of file FunctionalBasisInterface.C.
Helper function to store a value in #_series.
Definition at line 139 of file FunctionalBasisInterface.C.
Referenced by Legendre::evaluateOrthonormal(), Zernike::evaluateOrthonormal(), CompositeSeriesBasisInterface::evaluateSeries(), Legendre::evaluateSqrtMu(), Zernike::evaluateSqrtMu(), Legendre::evaluateStandard(), Zernike::evaluateStandard(), and Zernike::fillOutNegativeRankAndApplyAzimuthalComponent().
|
pure virtual |
Set the location that will be used by the series to compute values.
Implemented in CompositeSeriesBasisInterface, and SingleSeriesBasisInterface.
|
pure virtual |
Set the order of the series.
Implemented in CompositeSeriesBasisInterface, and SingleSeriesBasisInterface.
|
pure virtual |
Sets the bounds of the series.
Implemented in SingleSeriesBasisInterface, Cartesian, and CylindricalDuo.
|
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().
|
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(), and TEST().
|
protected |
indicates if the evaluated values correspond to the current location
Definition at line 146 of file FunctionalBasisInterface.h.
Referenced by getAllExpansion(), getAllGeneration(), SingleSeriesBasisInterface::isCacheInvalid(), SingleSeriesBasisInterface::setLocation(), SingleSeriesBasisInterface::setOrder(), and SingleSeriesBasisInterface::setPhysicalBounds().
|
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().
|
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().