Reference documentation for deal.II version GIT 3801df8983 2022-05-22 23:30:02+00:00
\(\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 | Public Attributes | Static Public Attributes | Protected Attributes | Private Attributes | List of all members
Functions::FlowFunction< dim > Class Template Referenceabstract

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

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

Public Types

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

Public Member Functions

 FlowFunction ()
 
virtual ~FlowFunction () override=default
 
void pressure_adjustment (double p)
 
virtual void vector_values (const std::vector< Point< dim >> &points, std::vector< std::vector< double >> &values) const override=0
 
virtual void vector_gradients (const std::vector< Point< dim >> &points, std::vector< std::vector< Tensor< 1, dim >>> &gradients) const override=0
 
virtual void vector_laplacians (const std::vector< Point< dim >> &points, std::vector< std::vector< double >> &values) const =0
 
virtual void vector_value (const Point< dim > &points, Vector< double > &value) const override
 
virtual double value (const Point< dim > &points, const unsigned int component) const override
 
virtual void vector_value_list (const std::vector< Point< dim >> &points, std::vector< Vector< double >> &values) const override
 
virtual void vector_gradient_list (const std::vector< Point< dim >> &points, std::vector< std::vector< Tensor< 1, dim >>> &gradients) const override
 
virtual void vector_laplacian_list (const std::vector< Point< dim >> &points, std::vector< Vector< double >> &values) const override
 
virtual std::size_t memory_consumption () const override
 
virtual void vector_value (const Point< dim > &p, Vector< RangeNumberType > &values) const
 
virtual void value_list (const std::vector< Point< dim >> &points, std::vector< RangeNumberType > &values, const unsigned int component=0) const
 
virtual void vector_value_list (const std::vector< Point< dim >> &points, std::vector< Vector< RangeNumberType >> &values) const
 
virtual void vector_values (const std::vector< Point< dim >> &points, std::vector< std::vector< RangeNumberType >> &values) const
 
virtual Tensor< 1, dim, RangeNumberType > gradient (const Point< dim > &p, const unsigned int component=0) const
 
virtual void vector_gradient (const Point< dim > &p, std::vector< Tensor< 1, dim, RangeNumberType >> &gradients) const
 
virtual void gradient_list (const std::vector< Point< dim >> &points, std::vector< Tensor< 1, dim, RangeNumberType >> &gradients, const unsigned int component=0) const
 
virtual void vector_gradients (const std::vector< Point< dim >> &points, std::vector< std::vector< Tensor< 1, dim, RangeNumberType >>> &gradients) const
 
virtual void vector_gradient_list (const std::vector< Point< dim >> &points, std::vector< std::vector< Tensor< 1, dim, RangeNumberType >>> &gradients) const
 
virtual RangeNumberType laplacian (const Point< dim > &p, const unsigned int component=0) const
 
virtual void vector_laplacian (const Point< dim > &p, Vector< RangeNumberType > &values) const
 
virtual void laplacian_list (const std::vector< Point< dim >> &points, std::vector< RangeNumberType > &values, const unsigned int component=0) const
 
virtual void vector_laplacian_list (const std::vector< Point< dim >> &points, std::vector< Vector< RangeNumberType >> &values) const
 
virtual SymmetricTensor< 2, dim, RangeNumberType > hessian (const Point< dim > &p, const unsigned int component=0) const
 
virtual void vector_hessian (const Point< dim > &p, std::vector< SymmetricTensor< 2, dim, RangeNumberType >> &values) const
 
virtual void hessian_list (const std::vector< Point< dim >> &points, std::vector< SymmetricTensor< 2, dim, RangeNumberType >> &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, RangeNumberType >>> &values) const
 
numbers::NumberTraits< double >::real_type get_time () const
 
virtual void set_time (const numbers::NumberTraits< double >::real_type new_time)
 
virtual void advance_time (const numbers::NumberTraits< double >::real_type delta_t)
 

Public Attributes

const unsigned int n_components
 

Static Public Attributes

static constexpr unsigned int dimension = dim
 

Protected Attributes

double mean_pressure
 

Private Attributes

Threads::Mutex mutex
 
std::vector< std::vector< double > > aux_values
 
std::vector< std::vector< Tensor< 1, dim > > > aux_gradients
 
numbers::NumberTraits< double >::real_type time
 

Subscriptor functionality

Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.

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
 
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
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
using map_value_type = decltype(counter_map)::value_type
 
using map_iterator = decltype(counter_map)::iterator
 
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 
void check_no_subscribers () const noexcept
 

Detailed Description

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

Base class for analytic solutions to incompressible flow problems.

Additional to the Function interface, this function provides for an offset of the pressure: if the pressure of the computed solution has an integral mean value different from zero, this value can be given to pressure_adjustment() in order to compute correct pressure errors.

Note
Derived classes should implement pressures with integral mean value zero always.
Thread safety: Some of the functions make use of internal data to compute values. Therefore, every thread should obtain its own object of derived classes.

Definition at line 48 of file flow_function.h.

Member Typedef Documentation

◆ time_type

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

The scalar-valued real type used for representing time.

Definition at line 169 of file function.h.

Constructor & Destructor Documentation

◆ FlowFunction()

template<int dim>
Functions::FlowFunction< dim >::FlowFunction

Constructor, setting up some internal data structures.

Definition at line 31 of file flow_function.cc.

◆ ~FlowFunction()

template<int dim>
virtual Functions::FlowFunction< dim >::~FlowFunction ( )
overridevirtualdefault

Virtual destructor.

Member Function Documentation

◆ pressure_adjustment()

template<int dim>
void Functions::FlowFunction< dim >::pressure_adjustment ( double  p)

Store an adjustment for the pressure function, such that its mean value is p.

Definition at line 42 of file flow_function.cc.

◆ vector_values() [1/2]

template<int dim>
virtual void Functions::FlowFunction< dim >::vector_values ( const std::vector< Point< dim >> &  points,
std::vector< std::vector< double >> &  values 
) const
overridepure virtual

Values in a structure more suitable for vector valued functions. The outer vector is indexed by solution component, the inner by quadrature point.

Implemented in Functions::StokesCosine< dim >, and Functions::PoisseuilleFlow< dim >.

◆ vector_gradients() [1/2]

template<int dim>
virtual void Functions::FlowFunction< dim >::vector_gradients ( const std::vector< Point< dim >> &  points,
std::vector< std::vector< Tensor< 1, dim >>> &  gradients 
) const
overridepure virtual

Gradients in a structure more suitable for vector valued functions. The outer vector is indexed by solution component, the inner by quadrature point.

Implemented in Functions::StokesCosine< dim >, and Functions::PoisseuilleFlow< dim >.

◆ vector_laplacians()

template<int dim>
virtual void Functions::FlowFunction< dim >::vector_laplacians ( const std::vector< Point< dim >> &  points,
std::vector< std::vector< double >> &  values 
) const
pure virtual

Force terms in a structure more suitable for vector valued functions. The outer vector is indexed by solution component, the inner by quadrature point.

Warning
This is not the true Laplacian, but the force term to be used as right hand side in Stokes' equations

Implemented in Functions::StokesCosine< dim >, and Functions::PoisseuilleFlow< dim >.

◆ vector_value() [1/2]

template<int dim>
void Functions::FlowFunction< dim >::vector_value ( const Point< dim > &  points,
Vector< double > &  value 
) const
overridevirtual

Definition at line 78 of file flow_function.cc.

◆ value()

template<int dim>
double Functions::FlowFunction< 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, RangeNumberType >.

Definition at line 103 of file flow_function.cc.

◆ vector_value_list() [1/2]

template<int dim>
void Functions::FlowFunction< dim >::vector_value_list ( const std::vector< Point< dim >> &  points,
std::vector< Vector< double >> &  values 
) const
overridevirtual

Definition at line 50 of file flow_function.cc.

◆ vector_gradient_list() [1/2]

template<int dim>
void Functions::FlowFunction< dim >::vector_gradient_list ( const std::vector< Point< dim >> &  points,
std::vector< std::vector< Tensor< 1, dim >>> &  gradients 
) const
overridevirtual

Definition at line 125 of file flow_function.cc.

◆ vector_laplacian_list() [1/2]

template<int dim>
void Functions::FlowFunction< dim >::vector_laplacian_list ( const std::vector< Point< dim >> &  points,
std::vector< Vector< double >> &  values 
) const
overridevirtual

The force term in the momentum equation.

Definition at line 153 of file flow_function.cc.

◆ memory_consumption()

template<int dim>
std::size_t Functions::FlowFunction< dim >::memory_consumption
overridevirtual

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

Reimplemented from Function< dim, RangeNumberType >.

Definition at line 181 of file flow_function.cc.

◆ vector_value() [2/2]

template<int dim, typename RangeNumberType = double>
virtual void Function< dim, RangeNumberType >::vector_value ( const Point< dim > &  p,
Vector< RangeNumberType > &  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.

Reimplemented in Functions::FEFieldFunction< dim, VectorType, spacedim >, and Functions::ConstantFunction< dim, double >.

◆ value_list()

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

Reimplemented in Functions::FEFieldFunction< dim, VectorType, spacedim >, and Functions::ConstantFunction< dim, double >.

◆ vector_value_list() [2/2]

template<int dim, typename RangeNumberType = double>
virtual void Function< dim, RangeNumberType >::vector_value_list ( const std::vector< Point< dim >> &  points,
std::vector< Vector< RangeNumberType >> &  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.

Reimplemented in Functions::FEFieldFunction< dim, VectorType, spacedim >, and Functions::ConstantFunction< dim, double >.

◆ vector_values() [2/2]

template<int dim, typename RangeNumberType = double>
virtual void Function< dim, RangeNumberType >::vector_values ( const std::vector< Point< dim >> &  points,
std::vector< std::vector< RangeNumberType >> &  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.

◆ gradient()

template<int dim, typename RangeNumberType = double>
virtual Tensor<1, dim, RangeNumberType> Function< dim, RangeNumberType >::gradient ( const Point< dim > &  p,
const unsigned int  component = 0 
) const
virtualinherited

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

Reimplemented in NonMatching::internal::DiscreteQuadratureGeneratorImplementation::RefSpaceFEFieldFunction< dim, VectorType >, Functions::SignedDistance::Sphere< dim >, Functions::CoordinateRestriction< dim >, Functions::FEFieldFunction< dim, VectorType, spacedim >, Functions::SymbolicFunction< dim, RangeNumberType >, Functions::Spherical< dim >, Functions::Polynomial< dim >, Functions::InterpolatedUniformGridData< dim >, Functions::InterpolatedTensorProductGridData< dim >, Functions::Monomial< dim, Number >, Functions::CutOffFunctionCinfty< dim >, Functions::CutOffFunctionC1< dim >, Functions::CutOffFunctionTensorProduct< dim >, Functions::FourierCosineSum< dim >, Functions::FourierSineSum< dim >, Functions::FourierSineFunction< dim >, Functions::FourierCosineFunction< dim >, Functions::JumpFunction< dim >, Functions::SlitSingularityFunction< dim >, Functions::ExpFunction< dim >, Functions::CosineFunction< dim >, Functions::PillowFunction< dim >, Functions::Q1WedgeFunction< dim >, Functions::SquareFunction< dim >, Functions::CSpline< dim >, Functions::Bessel1< dim >, FunctionFromFunctionObjects< dim, RangeNumberType >, Functions::IdentityFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, double >, AutoDerivativeFunction< dim >, Functions::CosineGradFunction< dim >, Functions::SignedDistance::Ellipsoid< dim >, and Functions::SignedDistance::Plane< dim >.

◆ vector_gradient()

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

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

Reimplemented in Functions::FEFieldFunction< dim, VectorType, spacedim >, and Functions::ConstantFunction< dim, double >.

◆ gradient_list()

template<int dim, typename RangeNumberType = double>
virtual void Function< dim, RangeNumberType >::gradient_list ( const std::vector< Point< dim >> &  points,
std::vector< Tensor< 1, dim, RangeNumberType >> &  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.

Reimplemented in Functions::ConstantFunction< dim, double >, and Functions::FEFieldFunction< dim, VectorType, spacedim >.

◆ vector_gradients() [2/2]

template<int dim, typename RangeNumberType = double>
virtual void Function< dim, RangeNumberType >::vector_gradients ( const std::vector< Point< dim >> &  points,
std::vector< std::vector< Tensor< 1, dim, RangeNumberType >>> &  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.

◆ vector_gradient_list() [2/2]

template<int dim, typename RangeNumberType = double>
virtual void Function< dim, RangeNumberType >::vector_gradient_list ( const std::vector< Point< dim >> &  points,
std::vector< std::vector< Tensor< 1, dim, RangeNumberType >>> &  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.

Reimplemented in Functions::ConstantFunction< dim, double >, and Functions::FEFieldFunction< dim, VectorType, spacedim >.

◆ laplacian()

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

◆ vector_laplacian()

template<int dim, typename RangeNumberType = double>
virtual void Function< dim, RangeNumberType >::vector_laplacian ( const Point< dim > &  p,
Vector< RangeNumberType > &  values 
) const
virtualinherited

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

Reimplemented in Functions::FEFieldFunction< dim, VectorType, spacedim >.

◆ laplacian_list()

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

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

Reimplemented in Functions::FEFieldFunction< dim, VectorType, spacedim >.

◆ vector_laplacian_list() [2/2]

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

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

Reimplemented in Functions::FEFieldFunction< dim, VectorType, spacedim >.

◆ hessian()

template<int dim, typename RangeNumberType = double>
virtual SymmetricTensor<2, dim, RangeNumberType> Function< dim, RangeNumberType >::hessian ( const Point< dim > &  p,
const unsigned int  component = 0 
) const
virtualinherited

◆ vector_hessian()

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

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

◆ hessian_list()

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

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

◆ vector_hessian_list()

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

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

◆ get_time()

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

Return the value of the time variable.

◆ set_time()

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

Set the time to new_time, overwriting the old value.

◆ advance_time()

virtual void FunctionTime< numbers::NumberTraits< double >::real_type >::advance_time ( const Number  delta_t)
virtualinherited

Advance the time by the given time step delta_t.

Member Data Documentation

◆ mean_pressure

template<int dim>
double Functions::FlowFunction< dim >::mean_pressure
protected

Mean value of the pressure to be added by derived classes.

Definition at line 127 of file flow_function.h.

◆ mutex

template<int dim>
Threads::Mutex Functions::FlowFunction< dim >::mutex
mutableprivate

A mutex that guards the following scratch arrays.

Definition at line 133 of file flow_function.h.

◆ aux_values

template<int dim>
std::vector<std::vector<double> > Functions::FlowFunction< dim >::aux_values
mutableprivate

Auxiliary values for the usual Function interface.

Definition at line 138 of file flow_function.h.

◆ aux_gradients

template<int dim>
std::vector<std::vector<Tensor<1, dim> > > Functions::FlowFunction< dim >::aux_gradients
mutableprivate

Auxiliary values for the usual Function interface.

Definition at line 143 of file flow_function.h.

◆ dimension

template<int dim, typename RangeNumberType = double>
constexpr unsigned int Function< dim, RangeNumberType >::dimension = dim
staticconstexprinherited

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

template<int dim, typename RangeNumberType = double>
const unsigned int Function< dim, RangeNumberType >::n_components
inherited

Number of vector components.

Definition at line 164 of file function.h.

◆ time

numbers::NumberTraits< double >::real_type FunctionTime< numbers::NumberTraits< double >::real_type >::time
privateinherited

Store the present time.

Definition at line 113 of file function_time.h.


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