deal.II version GIT relicensing-1929-g70a5450eef 2024-10-03 18:00:00+00:00
|
#include <deal.II/base/polynomial.h>
Public Member Functions | |
Hierarchical (const unsigned int p) | |
double | value (const double x) const |
void | value (const double x, std::vector< double > &values) const |
void | value (const Number2 x, const unsigned int n_derivatives, Number2 *values) const |
void | values_of_array (const std::array< Number2, n_entries > &points, const unsigned int n_derivatives, std::array< Number2, n_entries > *values) const |
unsigned int | degree () const |
void | scale (const double factor) |
void | shift (const number2 offset) |
Polynomial< double > | derivative () const |
Polynomial< double > | primitive () const |
Polynomial< double > & | operator*= (const double s) |
Polynomial< double > & | operator*= (const Polynomial< double > &p) |
Polynomial< double > & | operator+= (const Polynomial< double > &p) |
Polynomial< double > & | operator-= (const Polynomial< double > &p) |
bool | operator== (const Polynomial< double > &p) const |
void | print (std::ostream &out) const |
void | serialize (Archive &ar, const unsigned int version) |
virtual std::size_t | memory_consumption () const |
Subscriptor functionality | |
Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the ObserverPointer class. | |
void | subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const |
void | unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const |
unsigned int | n_subscriptions () const |
template<typename StreamType > | |
void | list_subscribers (StreamType &stream) const |
void | list_subscribers () const |
Static Public Member Functions | |
static std::vector< Polynomial< double > > | generate_complete_basis (const unsigned int degree) |
static ::ExceptionBase & | ExcInUse (int arg1, std::string arg2, std::string arg3) |
static ::ExceptionBase & | ExcNoSubscriber (std::string arg1, std::string arg2) |
Protected Member Functions | |
void | transform_into_standard_form () |
Static Protected Member Functions | |
static void | scale (std::vector< double > &coefficients, const double factor) |
static void | shift (std::vector< double > &coefficients, const number2 shift) |
static void | multiply (std::vector< double > &coefficients, const double factor) |
Protected Attributes | |
std::vector< double > | coefficients |
bool | in_lagrange_product_form |
std::vector< double > | lagrange_support_points |
double | lagrange_weight |
Private Types | |
using | map_value_type = decltype(counter_map)::value_type |
using | map_iterator = decltype(counter_map)::iterator |
Private Member Functions | |
void | check_no_subscribers () const noexcept |
Static Private Member Functions | |
static void | compute_coefficients (const unsigned int p) |
static const std::vector< double > & | get_coefficients (const unsigned int p) |
Private Attributes | |
std::atomic< unsigned int > | counter |
std::map< std::string, unsigned int > | counter_map |
std::vector< std::atomic< bool > * > | validity_pointers |
const std::type_info * | object_info |
Static Private Attributes | |
static std::vector< std::unique_ptr< const std::vector< double > > > | recursive_coefficients |
static std::shared_mutex | coefficients_lock |
static std::mutex | mutex |
Hierarchical polynomials of arbitrary degree on [0,1]
.
When Constructing a Hierarchical polynomial of degree p
, the coefficients will be computed by a recursion formula. The coefficients are stored in a static data vector to be available when needed next time.
These hierarchical polynomials are based on those of Demkowicz, Oden, Rachowicz, and Hardy (CMAME 77 (1989) 79-112, Sec. 4). The first two polynomials are the standard linear shape functions given by \(\phi_{0}(x) = 1 - x\) and \(\phi_{1}(x) = x\). For \(l \geq 2\) we use the definitions \(\phi_{l}(x) = (2x-1)^l - 1, l = 2,4,6,...\) and \(\phi_{l}(x) = (2x-1)^l - (2x-1), l = 3,5,7,...\). These satisfy the recursion relations \(\phi_{l}(x) = (2x-1)\phi_{l-1}, l=3,5,7,...\) and \(\phi_{l}(x) = (2x-1)\phi_{l-1} + \phi_{2}, l=4,6,8,...\).
The degrees of freedom are the values at the vertices and the derivatives at the midpoint. Currently, we do not scale the polynomials in any way, although better conditioning of the element stiffness matrix could possibly be achieved with scaling.
Calling the constructor with a given index p
will generate the following: if p==0
, then the resulting polynomial is the linear function associated with the left vertex, if p==1
the one associated with the right vertex. For higher values of p
, you get the polynomial of degree p
that is orthogonal to all previous ones. Note that for p==0
you therefore do not get a polynomial of degree zero, but one of degree one. This is to allow generating a complete basis for polynomial spaces, by just iterating over the indices given to the constructor.
On the other hand, the function generate_complete_basis() creates a complete basis of given degree. In order to be consistent with the concept of a polynomial degree, if the given argument is zero, it does not return the linear polynomial described above, but rather a constant polynomial.
Definition at line 532 of file polynomial.h.
|
privateinherited |
The data type used in counter_map.
Definition at line 230 of file subscriptor.h.
|
privateinherited |
The iterator type used in counter_map.
Definition at line 235 of file subscriptor.h.
Polynomials::Hierarchical::Hierarchical | ( | const unsigned int | p | ) |
Constructor for polynomial of degree p
. There is an exception for p==0
, see the general documentation.
Definition at line 856 of file polynomial.cc.
|
static |
Return a vector of Hierarchical polynomial objects of degrees zero through degree
, which then spans the full space of polynomials up to the given degree. Note that there is an exception if the given degree
equals zero, see the general documentation of this class.
This function may be used to initialize the TensorProductPolynomials, AnisotropicPolynomials, and PolynomialSpace classes.
Definition at line 1020 of file polynomial.cc.
|
staticprivate |
Compute coefficients recursively.
Definition at line 863 of file polynomial.cc.
|
staticprivate |
Get coefficients for constructor. This way, it can use the non-standard constructor of Polynomial.
Definition at line 1005 of file polynomial.cc.
|
inlineinherited |
Return the value of this polynomial at the given point.
This function uses the most numerically stable evaluation algorithm for the provided form of the polynomial. If the polynomial is in the product form of roots, the evaluation is based on products of the form (x - x_i), whereas the Horner scheme is used for polynomials in the coefficient form.
Definition at line 108 of file polynomial.h.
|
inherited |
Return the values and the derivatives of the Polynomial at point x
. values[i], i=0,...,values.size()-1
includes the i
th derivative. The number of derivatives to be computed is thus determined by the size of the array passed.
This function uses the Horner scheme for numerical stability of the evaluation for polynomials in the coefficient form or the product of terms involving the roots if that representation is used.
Definition at line 121 of file polynomial.cc.
|
inlineinherited |
Return the values and the derivatives of the Polynomial at point x
. values[i], i=0,...,n_derivatives
includes the i
th derivative. The number of derivatives to be computed is determined by n_derivatives
and values
has to provide sufficient space for n_derivatives
+ 1 values.
This function uses the most numerically stable evaluation algorithm for the provided form of the polynomial. If the polynomial is in the product form of roots, the evaluation is based on products of the form (x - x_i), whereas the Horner scheme is used for polynomials in the coefficient form.
The template type Number2
must implement arithmetic operations such as additions or multiplication with the type number
of the polynomial, and must be convertible from number
by operator=
.
Definition at line 143 of file polynomial.h.
|
inlineinherited |
Similar to the function above, but evaluate the polynomials on several positions at once, as described by the array argument points
. This function is can be faster than the other function when the same polynomial should be evaluated on several positions at once, e.g., the x,y,z coordinates of a point for tensor-product polynomials.
The template type Number2
must implement arithmetic operations such as additions or multiplication with the type number
of the polynomial, and must be convertible from number
by operator=
.
Definition at line 164 of file polynomial.h.
|
inlineinherited |
Degree of the polynomial. This is the degree reflected by the number of coefficients provided by the constructor. Leading non-zero coefficients are not treated separately.
Definition at line 174 of file polynomial.h.
|
inherited |
Scale the abscissa of the polynomial. Given the polynomial p(t) and the scaling t = ax, then the result of this operation is the polynomial q, such that q(x) = p(t).
The operation is performed in place.
Definition at line 184 of file polynomial.cc.
|
staticprotectedinherited |
This function performs the actual scaling.
Definition at line 274 of file polynomial.cc.
|
inherited |
Shift the abscissa oft the polynomial. Given the polynomial p(t) and the shift t = x + a, then the result of this operation is the polynomial q, such that q(x) = p(t).
The template parameter allows to compute the new coefficients with higher accuracy, since all computations are performed with type number2
. This may be necessary, since this operation involves a big number of additions. On a Sun Sparc Ultra with Solaris 2.8, the difference between double
and long double
was not significant, though.
The operation is performed in place, i.e. the coefficients of the present object are changed.
Definition at line 203 of file polynomial.cc.
|
staticprotectedinherited |
This function performs the actual shift
Definition at line 281 of file polynomial.cc.
|
inherited |
Compute the derivative of a polynomial.
Definition at line 209 of file polynomial.cc.
|
inherited |
Compute the primitive of a polynomial. the coefficient of the zero order term of the polynomial is zero.
Definition at line 216 of file polynomial.cc.
|
inherited |
Multiply with a scalar.
Definition at line 222 of file polynomial.cc.
|
inherited |
Multiply with another polynomial.
Definition at line 228 of file polynomial.cc.
|
inherited |
Add a second polynomial.
Definition at line 234 of file polynomial.cc.
|
inherited |
Subtract a second polynomial.
Definition at line 240 of file polynomial.cc.
|
inherited |
Test for equality of two polynomials.
Definition at line 246 of file polynomial.cc.
|
inherited |
Print coefficients.
Definition at line 252 of file polynomial.cc.
|
inlineinherited |
Write or read the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.
Definition at line 261 of file polynomial.h.
|
virtualinherited |
Return an estimate (in bytes) for the memory consumption of this object.
Definition at line 267 of file polynomial.cc.
|
staticprotectedinherited |
Multiply polynomial by a factor.
Definition at line 287 of file polynomial.cc.
|
protectedinherited |
Transform polynomial form of product of linear factors into standard form, \(\sum_i a_i x^i\). Deletes all data structures related to the product form.
Definition at line 295 of file polynomial.cc.
|
inherited |
Subscribes a user of the object by storing the pointer validity
. The subscriber may be identified by text supplied as identifier
.
Definition at line 130 of file subscriptor.cc.
|
inherited |
Unsubscribes a user from the object.
identifier
and the validity
pointer must be the same as the one supplied to subscribe(). Definition at line 150 of file subscriptor.cc.
|
inlineinherited |
Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.
Definition at line 301 of file subscriptor.h.
|
inlineinherited |
List the subscribers to the input stream
.
Definition at line 318 of file subscriptor.h.
|
inherited |
List the subscribers to deallog
.
Definition at line 198 of file subscriptor.cc.
|
privatenoexceptinherited |
Check that there are no objects subscribing to this object. If this check passes then it is safe to destroy the current object. It this check fails then this function will either abort or print an error message to deallog (by using the AssertNothrow mechanism), but will not throw an exception.
Definition at line 52 of file subscriptor.cc.
|
staticprivate |
Vector with already computed coefficients. For each degree of the polynomial, we keep one pointer to the list of coefficients; we do so rather than keeping a vector of vectors in order to simplify programming multithread-safe. In order to avoid memory leak, we use a unique_ptr in order to correctly free the memory of the vectors when the global destructor is called.
Definition at line 577 of file polynomial.h.
|
staticprivate |
The mutex that guards read and write access to the recursive_coefficients
array.
Definition at line 583 of file polynomial.h.
|
protectedinherited |
Coefficients of the polynomial \(\sum_i a_i x^i\). This vector is filled by the constructor of this class and may be passed down by derived classes.
This vector cannot be constant since we want to allow copying of polynomials.
Definition at line 305 of file polynomial.h.
|
protectedinherited |
Stores whether the polynomial is in Lagrange product form, i.e., constructed as a product \((x-x_0) (x-x_1) \ldots (x-x_n)/c\), or not.
Definition at line 311 of file polynomial.h.
|
protectedinherited |
If the polynomial is in Lagrange product form, i.e., constructed as a product \((x-x_0) (x-x_1) \ldots (x-x_n)/c\), store the shifts \(x_i\).
Definition at line 317 of file polynomial.h.
|
protectedinherited |
If the polynomial is in Lagrange product form, i.e., constructed as a product \((x-x_0) (x-x_1) \ldots (x-x_n)/c\), store the weight c.
Definition at line 323 of file polynomial.h.
|
mutableprivateinherited |
Store the number of objects which subscribed to this object. Initially, this number is zero, and upon destruction it shall be zero again (i.e. all objects which subscribed should have unsubscribed again).
The creator (and owner) of an object is counted in the map below if HE manages to supply identification.
We use the mutable
keyword in order to allow subscription to constant objects also.
This counter may be read from and written to concurrently in multithreaded code: hence we use the std::atomic
class template.
Definition at line 219 of file subscriptor.h.
|
mutableprivateinherited |
In this map, we count subscriptions for each different identification string supplied to subscribe().
Definition at line 225 of file subscriptor.h.
|
mutableprivateinherited |
In this vector, we store pointers to the validity bool in the ObserverPointer objects that subscribe to this class.
Definition at line 241 of file subscriptor.h.
|
mutableprivateinherited |
Pointer to the typeinfo object of this object, from which we can later deduce the class name. Since this information on the derived class is neither available in the destructor, nor in the constructor, we obtain it in between and store it here.
Definition at line 249 of file subscriptor.h.
|
staticprivateinherited |
A mutex used to ensure data consistency when accessing the mutable
members of this class. This lock is used in the subscribe() and unsubscribe() functions, as well as in list_subscribers()
.
Definition at line 272 of file subscriptor.h.