Reference documentation for deal.II version 9.3.0
Polynomials::PiecewisePolynomial< number > Class Template Reference

#include <deal.II/base/polynomials_piecewise.h>

Inheritance diagram for Polynomials::PiecewisePolynomial< number >:
[legend]

## Public Member Functions

PiecewisePolynomial (const Polynomial< number > &coefficients_on_interval, const unsigned int n_intervals, const unsigned int interval, const bool spans_next_interval)

number value (const number x) const

void value (const number x, std::vector< number > &values) const

void value (const number x, const unsigned int n_derivatives, number *values) const

unsigned int degree () const

template<class Archive >
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 SmartPointer 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 ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)

## Protected Attributes

Polynomial< number > polynomial

unsigned int n_intervals

unsigned int interval

bool spans_two_intervals

## Detailed Description

### template<typename number> class Polynomials::PiecewisePolynomial< number >

Definition of piecewise 1D polynomials for the unit interval. This space allows the description of interpolating polynomials on parts of the unit interval, similarly to the definition of finite element basis functions on subdivided elements. The primary purpose of this class is to allow constructing the shape functions of the FE_Q_iso_Q1 class that has a number of interpolation points in each coordinate direction, but instead of using them for higher-order polynomials just chooses piecewise linear shape functions – in effect, it is a $$Q_1$$ element defined on a subdivision of the reference cell, and replicated on each of these sub-cells.

This class is not derived from the ScalarPolynomialsBase base class because it is not actually a polynomial – it is a piecewise polynomial. However, it is interface-compatible with the Polynomials::Polynomial class, and consequently can be used as template argument for TensorProductPolynomials.

Definition at line 64 of file polynomials_piecewise.h.

## ◆ PiecewisePolynomial()

template<typename number >
 Polynomials::PiecewisePolynomial< number >::PiecewisePolynomial ( const Polynomial< number > & coefficients_on_interval, const unsigned int n_intervals, const unsigned int interval, const bool spans_next_interval )

Constructor for Lagrange polynomial on an interval that is a subset of the unit interval. It uses a polynomial description that is scaled to the size of the subinterval compared to the unit interval, the total number of intervals (subdivisions), the current index of the interval as well as if the polynomial spans onto the next interval (e.g., if it lives on two neighboring intervals).

If the number of intervals is one, the piecewise polynomial behaves exactly like a usual polynomial.

Definition at line 27 of file polynomials_piecewise.cc.

## ◆ value() [1/3]

template<typename number >
 number Polynomials::PiecewisePolynomial< number >::value ( const number x ) const
inline

Return the value of this polynomial at the given point, evaluating the underlying polynomial. The polynomial evaluates to zero when outside of the given interval (and possible the next one to the right when it spans over that range).

Definition at line 209 of file polynomials_piecewise.h.

## ◆ value() [2/3]

template<typename number >
 void Polynomials::PiecewisePolynomial< number >::value ( const number x, std::vector< number > & values ) const

Return the values and the derivatives of the Polynomial at point x. values[i], i=0,...,values.size()-1 includes the ith derivative. The number of derivatives to be computed is thus determined by the size of the vector passed.

Note that all the derivatives evaluate to zero at the border between intervals (assuming exact arithmetic) in the interior of the unit interval, as there is no unique gradient value in that case for a piecewise polynomial. This is not always desired (e.g., when evaluating jumps of gradients on the element boundary), but it is the user's responsibility to avoid evaluation at these points when it does not make sense.

Definition at line 45 of file polynomials_piecewise.cc.

## ◆ value() [3/3]

template<typename number >
 void Polynomials::PiecewisePolynomial< number >::value ( const number x, const unsigned int n_derivatives, number * values ) const

Return the values and the derivatives of the Polynomial at point x. values[i], i=0,...,n_derivatives includes the ith 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.

Note that all the derivatives evaluate to zero at the border between intervals (assuming exact arithmetic) in the interior of the unit interval, as there is no unique gradient value in that case for a piecewise polynomial. This is not always desired (e.g., when evaluating jumps of gradients on the element boundary), but it is the user's responsibility to avoid evaluation at these points when it does not make sense.

Definition at line 57 of file polynomials_piecewise.cc.

## ◆ degree()

template<typename number >
 unsigned int Polynomials::PiecewisePolynomial< number >::degree ( ) const
inline

Degree of the polynomial. This is the degree of the underlying base polynomial.

Definition at line 200 of file polynomials_piecewise.h.

## ◆ serialize()

template<typename number >
template<class Archive >
 void Polynomials::PiecewisePolynomial< number >::serialize ( Archive & ar, const unsigned int version )
inline

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 251 of file polynomials_piecewise.h.

## ◆ memory_consumption()

template<typename number >
 std::size_t Polynomials::PiecewisePolynomial< number >::memory_consumption ( ) const
virtual

Return an estimate (in bytes) for the memory consumption of this object.

Definition at line 123 of file polynomials_piecewise.cc.

## ◆ subscribe()

 void Subscriptor::subscribe ( std::atomic< bool > *const validity, const std::string & identifier = "" ) const
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 136 of file subscriptor.cc.

## ◆ unsubscribe()

 void Subscriptor::unsubscribe ( std::atomic< bool > *const validity, const std::string & identifier = "" ) const
inherited

Unsubscribes a user from the object.

Note
The identifier and the validity pointer must be the same as the one supplied to subscribe().

Definition at line 156 of file subscriptor.cc.

## ◆ n_subscriptions()

 unsigned int Subscriptor::n_subscriptions ( ) const
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.

## ◆ list_subscribers() [1/2]

template<typename StreamType >
 void Subscriptor::list_subscribers ( StreamType & stream ) const
inlineinherited

List the subscribers to the input stream.

Definition at line 318 of file subscriptor.h.

## ◆ list_subscribers() [2/2]

 void Subscriptor::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 204 of file subscriptor.cc.

## ◆ polynomial

template<typename number >
 Polynomial Polynomials::PiecewisePolynomial< number >::polynomial
protected

Underlying polynomial object that is scaled to a subinterval and concatenated accordingly.

Definition at line 156 of file polynomials_piecewise.h.

## ◆ n_intervals

template<typename number >
 unsigned int Polynomials::PiecewisePolynomial< number >::n_intervals
protected

A variable storing the number of intervals that the unit interval is divided into.

Definition at line 162 of file polynomials_piecewise.h.

## ◆ interval

template<typename number >
 unsigned int Polynomials::PiecewisePolynomial< number >::interval
protected

A variable storing the index of the current polynomial in the range of intervals.

Definition at line 168 of file polynomials_piecewise.h.

## ◆ spans_two_intervals

template<typename number >
 bool Polynomials::PiecewisePolynomial< number >::spans_two_intervals
protected

Store if the polynomial spans over two adjacent intervals, i.e., the one given in subinterval and the next one.

Definition at line 174 of file polynomials_piecewise.h.

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