PolynomialIF Class Reference
#include <PolynomialIF.H>
Detailed Description
This implicit function specifies a general polynomial function.Public Member Functions | |
| PolynomialIF (const Vector< PolyTerm > &a_polynomial, const bool &a_inside) | |
| PolynomialIF (const PolynomialIF &a_inputIF) | |
| Copy constructor. | |
| virtual | ~PolynomialIF () |
| Destructor. | |
| virtual void | GetParams (Vector< PolyTerm > &a_polynomial, bool &a_inside) const |
| virtual void | SetParams (const Vector< PolyTerm > &a_polynomial, const bool &a_inside) |
| virtual Real | value (const RealVect &a_point, const Vector< PolyTerm > &a_polynomial) const |
| virtual Real | value (const RealVect &a_point) const |
| virtual Real | value (const IndexTM< int, GLOBALDIM > &a_partialDerivative, const IndexTM< Real, GLOBALDIM > &a_point) const |
| virtual void | partialDerivative (Vector< PolyTerm > &a_partial, const IntVect &a_whichPartialOp, const Vector< PolyTerm > &a_polynomial) const |
| virtual BaseIF * | newImplicitFunction () const |
Protected Attributes | |
| Vector< PolyTerm > | m_polynomial |
| bool | m_inside |
Private Member Functions | |
| PolynomialIF () | |
| void | operator= (const PolynomialIF &a_inputIF) |
Constructor & Destructor Documentation
Constructor specifying the term composing the polynomial (a_polynomial) and whether the domain is on the inside (a_inside), i.e. where the function is negative.
| PolynomialIF::PolynomialIF | ( | const PolynomialIF & | a_inputIF | ) |
Copy constructor.
| virtual PolynomialIF::~PolynomialIF | ( | ) | [virtual] |
Destructor.
| PolynomialIF::PolynomialIF | ( | ) | [inline, private] |
References MayDay::Abort().
Member Function Documentation
| virtual void PolynomialIF::GetParams | ( | Vector< PolyTerm > & | a_polynomial, | |
| bool & | a_inside | |||
| ) | const [virtual] |
Return the parameter information
Referenced by ReferenceHeightIF::getReferenceSurfacePolynomial().
| virtual void PolynomialIF::SetParams | ( | const Vector< PolyTerm > & | a_polynomial, | |
| const bool & | a_inside | |||
| ) | [virtual] |
Set the parameter information
| virtual Real PolynomialIF::value | ( | const RealVect & | a_point, | |
| const Vector< PolyTerm > & | a_polynomial | |||
| ) | const [virtual] |
Return the value of the function at a_point using a_polynomial
Referenced by ReferenceHeightIF::evaluateReferenceSurfacePolynomial(), and ReferenceHeightIF::value().
Return the value of the function at a_point.
Implements BaseIF.
| virtual Real PolynomialIF::value | ( | const IndexTM< int, GLOBALDIM > & | a_partialDerivative, | |
| const IndexTM< Real, GLOBALDIM > & | a_point | |||
| ) | const [virtual] |
Return the value of the derivative at a_point.
Reimplemented from BaseIF.
| virtual void PolynomialIF::partialDerivative | ( | Vector< PolyTerm > & | a_partial, | |
| const IntVect & | a_whichPartialOp, | |||
| const Vector< PolyTerm > & | a_polynomial | |||
| ) | const [virtual] |
Partial derivative
| virtual BaseIF* PolynomialIF::newImplicitFunction | ( | ) | const [virtual] |
Return a newly allocated derived class. The responsibility for deleting the memory is left to the calling function.
Implements BaseIF.
| void PolynomialIF::operator= | ( | const PolynomialIF & | a_inputIF | ) | [inline, private] |
References MayDay::Abort().
Member Data Documentation
Vector<PolyTerm> PolynomialIF::m_polynomial [protected] |
bool PolynomialIF::m_inside [protected] |
The documentation for this class was generated from the following file:
