Reference documentation for deal.II version Git 73c87d96ef 2021-11-30 22:54:44 +0100
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ConstantTensorFunction< rank, dim, Number > Class Template Reference

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

Inheritance diagram for ConstantTensorFunction< rank, dim, Number >:
[legend]

Public Types

using time_type = typename TensorFunction< rank, dim, Number >::time_type
 
using value_type = Tensor< rank, dim, Number >
 
using gradient_type = Tensor< rank+1, dim, Number >
 

Public Member Functions

 ConstantTensorFunction (const ::Tensor< rank, dim, Number > &value, const time_type initial_time=0.0)
 
virtual ~ConstantTensorFunction () override=default
 
virtual typename ::TensorFunction< rank, dim, Number >::value_type value (const Point< dim > &p) const override
 
virtual void value_list (const std::vector< Point< dim >> &points, std::vector< typename ::TensorFunction< rank, dim, Number >::value_type > &values) const override
 
virtual typename ::TensorFunction< rank, dim, Number >::gradient_type gradient (const Point< dim > &p) const override
 
virtual void gradient_list (const std::vector< Point< dim >> &points, std::vector< typename ::TensorFunction< rank, dim, Number >::gradient_type > &gradients) const override
 
virtual void value_list (const std::vector< Point< dim >> &points, std::vector< value_type > &values) const
 
virtual void gradient_list (const std::vector< Point< dim >> &points, std::vector< gradient_type > &gradients) const
 
numbers::NumberTraits< Number >::real_type get_time () const
 
virtual void set_time (const numbers::NumberTraits< Number >::real_type new_time)
 
virtual void advance_time (const numbers::NumberTraits< Number >::real_type 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)
 

Private Attributes

const ::Tensor< rank, dim, Number > _value
 

Detailed Description

template<int rank, int dim, typename Number = double>
class ConstantTensorFunction< rank, dim, Number >

Provide a tensor valued function which always returns a constant tensor value. Obviously, all derivates of this function are zero.

Definition at line 130 of file tensor_function.h.

Member Typedef Documentation

◆ time_type

template<int rank, int dim, typename Number = double>
using ConstantTensorFunction< rank, dim, Number >::time_type = typename TensorFunction<rank, dim, Number>::time_type

The scalar-valued real type used for representing time.

Definition at line 136 of file tensor_function.h.

◆ value_type

template<int rank, int dim, typename Number = double>
using TensorFunction< rank, dim, Number >::value_type = Tensor<rank, dim, Number>
inherited

Alias for the return types of the value function.

Definition at line 64 of file tensor_function.h.

◆ gradient_type

template<int rank, int dim, typename Number = double>
using TensorFunction< rank, dim, Number >::gradient_type = Tensor<rank + 1, dim, Number>
inherited

Alias for the return types of the gradient functions.

Definition at line 69 of file tensor_function.h.

Constructor & Destructor Documentation

◆ ConstantTensorFunction()

template<int rank, int dim, typename Number = double>
ConstantTensorFunction< rank, dim, Number >::ConstantTensorFunction ( const ::Tensor< rank, dim, Number > &  value,
const time_type  initial_time = 0.0 
)

Constructor; takes the constant tensor value as an argument. The reference value is copied internally.

An initial value for the time variable may be specified, otherwise it defaults to zero.

◆ ~ConstantTensorFunction()

template<int rank, int dim, typename Number = double>
virtual ConstantTensorFunction< rank, dim, Number >::~ConstantTensorFunction ( )
overridevirtualdefault

Member Function Documentation

◆ value()

template<int rank, int dim, typename Number = double>
virtual typename ::TensorFunction<rank, dim, Number>::value_type ConstantTensorFunction< rank, dim, Number >::value ( const Point< dim > &  p) const
overridevirtual

Return the value of the function at the given point.

Reimplemented from TensorFunction< rank, dim, Number >.

◆ value_list() [1/2]

template<int rank, int dim, typename Number = double>
virtual void ConstantTensorFunction< rank, dim, Number >::value_list ( const std::vector< Point< dim >> &  points,
std::vector< typename ::TensorFunction< rank, dim, Number >::value_type > &  values 
) const
overridevirtual

◆ gradient()

template<int rank, int dim, typename Number = double>
virtual typename ::TensorFunction<rank, dim, Number>::gradient_type ConstantTensorFunction< rank, dim, Number >::gradient ( const Point< dim > &  p) const
overridevirtual

Return the gradient of the function at the given point.

Reimplemented from TensorFunction< rank, dim, Number >.

◆ gradient_list() [1/2]

template<int rank, int dim, typename Number = double>
virtual void ConstantTensorFunction< rank, dim, Number >::gradient_list ( const std::vector< Point< dim >> &  points,
std::vector< typename ::TensorFunction< rank, dim, Number >::gradient_type > &  gradients 
) const
overridevirtual

◆ value_list() [2/2]

template<int rank, int dim, typename Number = double>
virtual void TensorFunction< rank, dim, Number >::value_list ( const std::vector< Point< dim >> &  points,
std::vector< value_type > &  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.

◆ gradient_list() [2/2]

template<int rank, int dim, typename Number = double>
virtual void TensorFunction< rank, dim, Number >::gradient_list ( const std::vector< Point< dim >> &  points,
std::vector< gradient_type > &  gradients 
) const
virtualinherited

Set gradients to the gradients 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.

◆ get_time()

numbers::NumberTraits< Number >::real_type FunctionTime< numbers::NumberTraits< Number >::real_type >::get_time ( ) const
inherited

Return the value of the time variable.

◆ set_time()

virtual void FunctionTime< numbers::NumberTraits< Number >::real_type >::set_time ( const numbers::NumberTraits< Number >::real_type  new_time)
virtualinherited

Set the time to new_time, overwriting the old value.

◆ advance_time()

virtual void FunctionTime< numbers::NumberTraits< Number >::real_type >::advance_time ( const numbers::NumberTraits< Number >::real_type  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.

Member Data Documentation

◆ _value

template<int rank, int dim, typename Number = double>
const ::Tensor<rank, dim, Number> ConstantTensorFunction< rank, dim, Number >::_value
private

Definition at line 170 of file tensor_function.h.


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