Reference documentation for deal.II version GIT relicensing-16-gf4f69b3b42 2024-02-27 08:20:02+00:00
Searching...
No Matches
Functions::Kovasznay Class Referenceabstract

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

Inheritance diagram for Functions::Kovasznay:
[legend]

## Public Types

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

## Public Member Functions

Kovasznay (const double Re, bool Stokes=false)

virtual ~Kovasznay () override=default

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

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

virtual void vector_laplacians (const std::vector< Point< 2 > > &points, std::vector< std::vector< double > > &values) const override

double lambda () const
The value of lambda.

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

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

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

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

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 void vector_value (const Point< dim > &p, Vector< RangeNumberType > &values) const

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_value_list (const std::vector< Point< dim > > &points, std::vector< Vector< RangeNumberType > > &values) const

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

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

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

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

virtual std::size_t memory_consumption () const override

virtual void value_list (const std::vector< Point< dim > > &points, std::vector< RangeNumberType > &values, const unsigned int component=0) 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 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 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

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 constexpr unsigned int dimension = dim

## Protected Attributes

double mean_pressure

## 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

## Private Attributes

const double Reynolds

double lbda

double p_average

const bool stokes

std::vector< std::vector< double > > aux_values

std::vector< std::vector< Tensor< 1, dim > > > aux_gradients

Number time

std::atomic< unsigned intcounter

std::map< std::string, unsigned intcounter_map

std::vector< std::atomic< bool > * > validity_pointers

const std::type_info * object_info

## Detailed Description

Flow solution in 2d by Kovasznay (1947).

This function is valid on the half plane right of the line x=1/2.

Definition at line 298 of file flow_function.h.

## ◆ time_type

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

The scalar-valued real type used for representing time.

Definition at line 168 of file function.h.

## ◆ map_value_type

 using Subscriptor::map_value_type = decltype(counter_map)::value_type
privateinherited

The data type used in counter_map.

Definition at line 229 of file subscriptor.h.

## ◆ map_iterator

 using Subscriptor::map_iterator = decltype(counter_map)::iterator
privateinherited

The iterator type used in counter_map.

Definition at line 234 of file subscriptor.h.

## ◆ Kovasznay()

 Functions::Kovasznay::Kovasznay ( const double Re, bool Stokes = false )

Construct an object for the give Reynolds number Re. If the parameter Stokes is true, the right hand side of the momentum equation returned by vector_laplacians() contains the nonlinearity, such that the Kovasznay solution can be obtained as the solution to a Stokes problem.

Definition at line 662 of file flow_function.cc.

## ◆ ~Kovasznay()

 virtual Functions::Kovasznay::~Kovasznay ( )
overridevirtualdefault

## ◆ vector_values() [1/3]

 void Functions::Kovasznay::vector_values ( const std::vector< Point< 2 > > & points, std::vector< std::vector< double > > & values ) const
overridevirtual

Definition at line 679 of file flow_function.cc.

 void Functions::Kovasznay::vector_gradients ( const std::vector< Point< 2 > > & points, std::vector< std::vector< Tensor< 1, 2 > > > & gradients ) const
overridevirtual

Definition at line 703 of file flow_function.cc.

## ◆ vector_laplacians() [1/2]

 void Functions::Kovasznay::vector_laplacians ( const std::vector< Point< 2 > > & points, std::vector< std::vector< double > > & values ) const
overridevirtual

Definition at line 736 of file flow_function.cc.

## ◆ lambda()

 double Functions::Kovasznay::lambda ( ) const

The value of lambda.

Definition at line 773 of file flow_function.cc.

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

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

Definition at line 65 of file flow_function.cc.

## ◆ vector_values() [2/3]

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

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

## ◆ vector_values() [3/3]

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.

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

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

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.

Reimplemented in VectorFunctionFromTensorFunction< dim, RangeNumberType >.

## ◆ vector_laplacians() [2/2]

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

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

## ◆ vector_value() [1/2]

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

Definition at line 97 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.

## ◆ value()

 double Functions::FlowFunction< dim >::value ( const Point< dim > & points, const unsigned int component ) const
overridevirtualinherited

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 100 of file flow_function.cc.

## ◆ vector_value_list() [1/2]

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

Definition at line 103 of file flow_function.cc.

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

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

Definition at line 106 of file flow_function.cc.

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.

## ◆ vector_laplacian_list() [1/2]

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

The force term in the momentum equation.

Definition at line 113 of file flow_function.cc.

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

## ◆ memory_consumption()

 std::size_t Functions::FlowFunction< dim >::memory_consumption ( ) const
overridevirtualinherited

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

Reimplemented from Function< dim, RangeNumberType >.

Definition at line 120 of file flow_function.cc.

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

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

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.

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.

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

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

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

## ◆ 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()

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 135 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 155 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 300 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 317 of file subscriptor.h.

## ◆ list_subscribers() [2/2]

 void Subscriptor::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 203 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 309 of file subscriptor.h.

## ◆ check_no_subscribers()

 void Subscriptor::check_no_subscribers ( ) const
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.

Note
Since this function is just a consistency check it does nothing in release mode.
If this function is called when there is an uncaught exception then, rather than aborting, this function prints an error message to the standard error stream and returns.

Definition at line 52 of file subscriptor.cc.

## ◆ Reynolds

 const double Functions::Kovasznay::Reynolds
private

Definition at line 328 of file flow_function.h.

## ◆ lbda

 double Functions::Kovasznay::lbda
private

Definition at line 329 of file flow_function.h.

## ◆ p_average

 double Functions::Kovasznay::p_average
private

Definition at line 330 of file flow_function.h.

## ◆ stokes

 const bool Functions::Kovasznay::stokes
private

Definition at line 331 of file flow_function.h.

## ◆ mean_pressure

 double Functions::FlowFunction< dim >::mean_pressure
protectedinherited

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

Definition at line 126 of file flow_function.h.

## ◆ mutex

mutableprivateinherited

A mutex that guards the following scratch arrays.

Definition at line 132 of file flow_function.h.

## ◆ aux_values

 std::vector > Functions::FlowFunction< dim >::aux_values
mutableprivateinherited

Auxiliary values for the usual Function interface.

Definition at line 137 of file flow_function.h.

 std::vector > > Functions::FlowFunction< dim >::aux_gradients
mutableprivateinherited

Auxiliary values for the usual Function interface.

Definition at line 142 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 158 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 163 of file function.h.

## ◆ time

template<typename Number = double>
 Number FunctionTime< Number >::time
privateinherited

Store the present time.

Definition at line 112 of file function_time.h.

## ◆ counter

 std::atomic Subscriptor::counter
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 218 of file subscriptor.h.

## ◆ counter_map

 std::map Subscriptor::counter_map
mutableprivateinherited

In this map, we count subscriptions for each different identification string supplied to subscribe().

Definition at line 224 of file subscriptor.h.

## ◆ validity_pointers

 std::vector *> Subscriptor::validity_pointers
mutableprivateinherited

In this vector, we store pointers to the validity bool in the SmartPointer objects that subscribe to this class.

Definition at line 240 of file subscriptor.h.

## ◆ object_info

 const std::type_info* Subscriptor::object_info
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 248 of file subscriptor.h.

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