Reference documentation for deal.II version Git e413cbf8ac 2021-08-02 21:56:02 +0200
Functions::CoordinateRestriction< dim > Class Template Reference

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

Inheritance diagram for Functions::CoordinateRestriction< dim >:
[legend]

Public Types

using time_type = typename FunctionTime< typename numbers::NumberTraits< double >::real_type >::time_type

Public Member Functions

CoordinateRestriction (const Function< dim+1 > &function, const unsigned int direction, const double coordinate_value)

double value (const Point< dim > &point, const unsigned int component) const override

Tensor< 1, dim > gradient (const Point< dim > &point, const unsigned int component) const override

SymmetricTensor< 2, dim > hessian (const Point< dim > &point, const unsigned int component) const override

virtual void vector_value (const Point< dim > &p, Vector< double > &values) const

virtual void value_list (const std::vector< Point< dim >> &points, std::vector< double > &values, const unsigned int component=0) const

virtual void vector_value_list (const std::vector< Point< dim >> &points, std::vector< Vector< double >> &values) const

virtual void vector_values (const std::vector< Point< dim >> &points, std::vector< std::vector< double >> &values) const

virtual void vector_gradient (const Point< dim > &p, std::vector< Tensor< 1, dim, double >> &gradients) const

virtual void gradient_list (const std::vector< Point< dim >> &points, std::vector< Tensor< 1, dim, double >> &gradients, const unsigned int component=0) const

virtual void vector_gradients (const std::vector< Point< dim >> &points, std::vector< std::vector< Tensor< 1, dim, double >>> &gradients) const

virtual void vector_gradient_list (const std::vector< Point< dim >> &points, std::vector< std::vector< Tensor< 1, dim, double >>> &gradients) const

virtual double laplacian (const Point< dim > &p, const unsigned int component=0) const

virtual void vector_laplacian (const Point< dim > &p, Vector< double > &values) const

virtual void laplacian_list (const std::vector< Point< dim >> &points, std::vector< double > &values, const unsigned int component=0) const

virtual void vector_laplacian_list (const std::vector< Point< dim >> &points, std::vector< Vector< double >> &values) const

virtual void vector_hessian (const Point< dim > &p, std::vector< SymmetricTensor< 2, dim, double >> &values) const

virtual void hessian_list (const std::vector< Point< dim >> &points, std::vector< SymmetricTensor< 2, dim, double >> &values, const unsigned int component=0) const

virtual void vector_hessian_list (const std::vector< Point< dim >> &points, std::vector< std::vector< SymmetricTensor< 2, dim, double >>> &values) const

virtual std::size_t memory_consumption () const

Number get_time () const

virtual void set_time (const Number new_time)

virtual void advance_time (const Number delta_t)

template<class Archive >
void serialize (Archive &ar, const unsigned int version)

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)

Public Attributes

const unsigned int n_components

Static Public Attributes

static const unsigned int dimension

Private Attributes

const SmartPointer< const Function< dim+1 > > function

const unsigned int restricted_direction

const double coordinate_value

Detailed Description

template<int dim> class Functions::CoordinateRestriction< dim >

This class takes a function in dim + 1 dimensions and creates a new function in one dimension lower by restricting one of the coordinates to a given value. Mathematically this corresponds to taking a function $$f = f(x, y, z)$$, a fixed value, $$Z$$, and defining a new function (the restriction) $$g = g(x, y) = f(x, y, Z)$$. Using this class, this translates to

Function<3> & function = ...
double z = ...
unsigned int restricted_direction = 2;
CoordinateRestriction<2> restriction(function, restricted_direction, z);

The dim-dimensional coordinates on the restriction are ordered starting from the restricted (dim + 1)-coordinate. In particular, this means that if the $$y$$-coordinate is locked to $$Y$$ in 3D, the coordinates are ordered as $$(z, x)$$ on the restriction: $$g = g(z, x) = f(x, Y, z)$$. This is the same convention as in BoundingBox::cross_section.

Definition at line 51 of file function_restriction.h.

◆ time_type

 using Function< dim, double >::time_type = typename FunctionTime< typename numbers::NumberTraits::real_type>::time_type
inherited

The scalar-valued real type used for representing time.

Definition at line 170 of file function.h.

◆ CoordinateRestriction()

template<int dim>
 Functions::CoordinateRestriction< dim >::CoordinateRestriction ( const Function< dim+1 > & function, const unsigned int direction, const double coordinate_value )

Constructor, takes the (dim + 1)-coordinate direction and the value that the incoming function should be restricted to.

A pointer to the incoming function is stored internally, so the function must have a longer lifetime than the created restriction.

Definition at line 49 of file function_restriction.cc.

◆ value()

template<int dim>
 double Functions::CoordinateRestriction< dim >::value ( const Point< dim > & p, const unsigned int component ) const
overridevirtual

Return the value of the function at the given point. Unless there is only one component (i.e. the function is scalar), you should state the component you want to have evaluated; it defaults to zero, i.e. the first component.

Reimplemented from Function< dim >.

Definition at line 64 of file function_restriction.cc.

template<int dim>
 Tensor< 1, dim > Functions::CoordinateRestriction< dim >::gradient ( const Point< dim > & p, const unsigned int component ) const
overridevirtual

Return the gradient of the specified component of the function at the given point.

Reimplemented from Function< dim >.

Definition at line 79 of file function_restriction.cc.

◆ hessian()

template<int dim>
 SymmetricTensor< 2, dim > Functions::CoordinateRestriction< dim >::hessian ( const Point< dim > & p, const unsigned int component ) const
overridevirtual

Compute the Hessian of a given component at point p, that is the gradient of the gradient of the function.

Reimplemented from Function< dim >.

Definition at line 107 of file function_restriction.cc.

◆ vector_value()

 virtual void Function< dim, double >::vector_value ( const Point< dim > & p, Vector< double > & values ) const
virtualinherited

Return all components of a vector-valued function at a given point.

values shall have the right size beforehand, i.e. n_components.

The default implementation will call value() for each component.

◆ value_list()

 virtual void Function< dim, double >::value_list ( const std::vector< Point< dim >> & points, std::vector< double > & values, const unsigned int component = 0 ) const
virtualinherited

Set values to the point values of the specified component of the function at the points. It is assumed that values already has the right size, i.e. the same size as the points array.

By default, this function repeatedly calls value() for each point separately, to fill the output array.

◆ vector_value_list()

 virtual void Function< dim, double >::vector_value_list ( const std::vector< Point< dim >> & points, std::vector< Vector< double >> & values ) const
virtualinherited

Set values to the point values of the function at the points. It is assumed that values already has the right size, i.e. the same size as the points array, and that all elements be vectors with the same number of components as this function has.

By default, this function repeatedly calls vector_value() for each point separately, to fill the output array.

◆ vector_values()

 virtual void Function< dim, double >::vector_values ( const std::vector< Point< dim >> & points, std::vector< std::vector< double >> & values ) const
virtualinherited

For each component of the function, fill a vector of values, one for each point.

The default implementation of this function in Function calls value_list() for each component. In order to improve performance, this can be reimplemented in derived classes to speed up performance.

 virtual void Function< dim, double >::vector_gradient ( const Point< dim > & p, std::vector< Tensor< 1, dim, double >> & gradients ) const
virtualinherited

Return the gradient of all components of the function at the given point.

 virtual void Function< dim, double >::gradient_list ( const std::vector< Point< dim >> & points, std::vector< Tensor< 1, dim, double >> & gradients, const unsigned int component = 0 ) const
virtualinherited

Set gradients to the gradients of the specified component of the function at the points. It is assumed that gradients already has the right size, i.e. the same size as the points array.

 virtual void Function< dim, double >::vector_gradients ( const std::vector< Point< dim >> & points, std::vector< std::vector< Tensor< 1, dim, double >>> & gradients ) const
virtualinherited

For each component of the function, fill a vector of gradient values, one for each point.

The default implementation of this function in Function calls value_list() for each component. In order to improve performance, this can be reimplemented in derived classes to speed up performance.

 virtual void Function< dim, double >::vector_gradient_list ( const std::vector< Point< dim >> & points, std::vector< std::vector< Tensor< 1, dim, double >>> & gradients ) const
virtualinherited

Set gradients to the gradients of the function at the points, for all components. It is assumed that gradients already has the right size, i.e. the same size as the points array.

The outer loop over gradients is over the points in the list, the inner loop over the different components of the function.

◆ laplacian()

 virtual double Function< dim, double >::laplacian ( const Point< dim > & p, const unsigned int component = 0 ) const
virtualinherited

Compute the Laplacian of a given component at point p.

◆ vector_laplacian()

 virtual void Function< dim, double >::vector_laplacian ( const Point< dim > & p, Vector< double > & values ) const
virtualinherited

Compute the Laplacian of all components at point p and store them in values.

◆ laplacian_list()

 virtual void Function< dim, double >::laplacian_list ( const std::vector< Point< dim >> & points, std::vector< double > & values, const unsigned int component = 0 ) const
virtualinherited

Compute the Laplacian of one component at a set of points.

◆ vector_laplacian_list()

 virtual void Function< dim, double >::vector_laplacian_list ( const std::vector< Point< dim >> & points, std::vector< Vector< double >> & values ) const
virtualinherited

Compute the Laplacians of all components at a set of points.

Reimplemented in Functions::FlowFunction< dim >, and Functions::FlowFunction< 2 >.

◆ vector_hessian()

 virtual void Function< dim, double >::vector_hessian ( const Point< dim > & p, std::vector< SymmetricTensor< 2, dim, double >> & values ) const
virtualinherited

Compute the Hessian of all components at point p and store them in values.

◆ hessian_list()

 virtual void Function< dim, double >::hessian_list ( const std::vector< Point< dim >> & points, std::vector< SymmetricTensor< 2, dim, double >> & values, const unsigned int component = 0 ) const
virtualinherited

Compute the Hessian of one component at a set of points.

◆ vector_hessian_list()

 virtual void Function< dim, double >::vector_hessian_list ( const std::vector< Point< dim >> & points, std::vector< std::vector< SymmetricTensor< 2, dim, double >>> & values ) const
virtualinherited

Compute the Hessians of all components at a set of points.

◆ memory_consumption()

 virtual std::size_t Function< dim, double >::memory_consumption ( ) const
virtualinherited

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

This function is virtual and can be overloaded by derived classes.

◆ get_time()

template<typename Number = double>
 Number FunctionTime< Number >::get_time ( ) const
inherited

Return the value of the time variable.

◆ set_time()

template<typename Number = double>
 virtual void FunctionTime< Number >::set_time ( const Number new_time )
virtualinherited

Set the time to new_time, overwriting the old value.

template<typename Number = double>
 virtual void FunctionTime< Number >::advance_time ( const Number delta_t )
virtualinherited

Advance the time by the given time step delta_t.

◆ 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.

◆ serialize()

template<class Archive >
 void Subscriptor::serialize ( Archive & ar, const unsigned int version )
inlineinherited

Read or write the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.

This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.

Definition at line 310 of file subscriptor.h.

◆ function

template<int dim>
 const SmartPointer > Functions::CoordinateRestriction< dim >::function
private

Definition at line 78 of file function_restriction.h.

◆ restricted_direction

template<int dim>
 const unsigned int Functions::CoordinateRestriction< dim >::restricted_direction
private

Definition at line 81 of file function_restriction.h.

◆ coordinate_value

template<int dim>
 const double Functions::CoordinateRestriction< dim >::coordinate_value
private

Definition at line 84 of file function_restriction.h.

◆ dimension

 const unsigned int Function< dim, double >::dimension
staticinherited

Export the value of the template parameter as a static member constant. Sometimes useful for some expression template programming.

Definition at line 159 of file function.h.

◆ n_components

 const unsigned int Function< dim, double >::n_components
inherited

Number of vector components.

Definition at line 164 of file function.h.

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