 |
Reference documentation for deal.II version 9.5.0
|
Loading...
Searching...
No Matches
|
Reference documentation for deal.II version 9.5.0
|
#include <deal.II/base/flow_function.h>
Public Types | |
| using | time_type = typename FunctionTime< typename numbers::NumberTraits< RangeNumberType >::real_type >::time_type |
Public Member Functions | |
| StokesCosine (const double viscosity=1., const double reaction=0.) | |
| void | set_parameters (const double viscosity, const double reaction) |
| virtual | ~StokesCosine () override=default |
| virtual void | vector_values (const std::vector< Point< dim > > &points, std::vector< std::vector< double > > &values) const override |
| virtual void | vector_gradients (const std::vector< Point< dim > > &points, std::vector< std::vector< Tensor< 1, dim > > > &gradients) const override |
| virtual void | vector_laplacians (const std::vector< Point< dim > > &points, std::vector< std::vector< double > > &values) const override |
| void | pressure_adjustment (double p) |
| 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, RangeNumberType > > > &gradients) const |
| 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 ::ExceptionBase & | ExcInUse (int arg1, std::string arg2, std::string arg3) |
| static ::ExceptionBase & | ExcNoSubscriber (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 | |
| double | viscosity |
| The viscosity. | |
| double | reaction |
| The reaction parameter. | |
| Threads::Mutex | mutex |
| std::vector< std::vector< double > > | aux_values |
| std::vector< std::vector< Tensor< 1, dim > > > | aux_gradients |
| Number | time |
| 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 |
Artificial divergence free function with homogeneous boundary conditions on the cube [-1,1]dim.
The function in 2d is
\[ \left(\begin{array}{c}u\\v\\p\end{array}\right) \left(\begin{array}{c}\cos^2x \sin y\cos y\\-\sin x\cos x\cos^2y\\ \sin x\cos x\sin y\cos y\end{array}\right) \]
Definition at line 195 of file flow_function.h.
|
inherited |
The scalar-valued real type used for representing time.
Definition at line 169 of file function.h.
|
privateinherited |
The data type used in counter_map.
Definition at line 230 of file subscriptor.h.
|
privateinherited |
The iterator type used in counter_map.
Definition at line 235 of file subscriptor.h.
| Functions::StokesCosine< dim >::StokesCosine | ( | const double | viscosity = 1., |
| const double | reaction = 0. |
||
| ) |
Constructor setting the Reynolds number required for pressure computation and scaling of the right hand side.
Definition at line 288 of file flow_function.cc.
|
overridevirtualdefault |
| void Functions::StokesCosine< dim >::set_parameters | ( | const double | viscosity, |
| const double | reaction | ||
| ) |
Change the viscosity and the reaction parameter.
Definition at line 297 of file flow_function.cc.
|
overridevirtual |
Values in a structure more suitable for vector valued functions. The outer vector is indexed by solution component, the inner by quadrature point.
Implements Functions::FlowFunction< dim >.
Definition at line 306 of file flow_function.cc.
|
overridevirtual |
Gradients in a structure more suitable for vector valued functions. The outer vector is indexed by solution component, the inner by quadrature point.
Implements Functions::FlowFunction< dim >.
Definition at line 355 of file flow_function.cc.
|
overridevirtual |
Force terms in a structure more suitable for vector valued functions. The outer vector is indexed by solution component, the inner by quadrature point.
Implements Functions::FlowFunction< dim >.
Definition at line 421 of file flow_function.cc.
|
inherited |
Store an adjustment for the pressure function, such that its mean value is p.
Definition at line 42 of file flow_function.cc.
|
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.
|
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.
|
overridevirtualinherited |
Definition at line 78 of file flow_function.cc.
|
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::ConstantFunction< dim, RangeNumberType >, ComponentSelectFunction< dim, RangeNumberType >, VectorFunctionFromScalarFunctionObject< dim, RangeNumberType >, VectorFunctionFromTensorFunction< dim, RangeNumberType >, Functions::IncrementalFunction< dim, RangeNumberType >, and Functions::FEFieldFunction< dim, VectorType, spacedim >.
|
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 103 of file flow_function.cc.
|
overridevirtualinherited |
Definition at line 50 of file flow_function.cc.
|
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::ConstantFunction< dim, RangeNumberType >, VectorFunctionFromTensorFunction< dim, RangeNumberType >, ComponentSelectFunction< dim, RangeNumberType >, and Functions::FEFieldFunction< dim, VectorType, spacedim >.
|
overridevirtualinherited |
Definition at line 125 of file flow_function.cc.
|
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::FEFieldFunction< dim, VectorType, spacedim >, and Functions::ConstantFunction< dim, RangeNumberType >.
|
overridevirtualinherited |
The force term in the momentum equation.
Definition at line 153 of file flow_function.cc.
|
virtualinherited |
Compute the Laplacians of all components at a set of points.
Reimplemented in Functions::FEFieldFunction< dim, VectorType, spacedim >.
|
overridevirtualinherited |
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.
|
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::ConstantFunction< dim, RangeNumberType >, and Functions::FEFieldFunction< dim, VectorType, spacedim >.
|
virtualinherited |
Return the gradient of the specified component of the function at the given point.
Reimplemented in Functions::SignedDistance::Plane< dim >, Functions::SignedDistance::Ellipsoid< dim >, Functions::CosineGradFunction< dim >, AutoDerivativeFunction< dim >, Functions::ConstantFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, double >, Functions::IdentityFunction< dim, RangeNumberType >, FunctionFromFunctionObjects< dim, RangeNumberType >, Functions::Bessel1< dim >, Functions::CSpline< dim >, Functions::SquareFunction< dim >, Functions::Q1WedgeFunction< dim >, Functions::PillowFunction< dim >, Functions::CosineFunction< dim >, Functions::ExpFunction< dim >, Functions::SlitSingularityFunction< dim >, Functions::JumpFunction< dim >, Functions::FourierCosineFunction< dim >, Functions::FourierSineFunction< dim >, Functions::FourierSineSum< dim >, Functions::FourierCosineSum< dim >, Functions::CutOffFunctionTensorProduct< dim >, Functions::CutOffFunctionC1< dim >, Functions::CutOffFunctionCinfty< dim >, Functions::Monomial< dim, Number >, Functions::InterpolatedTensorProductGridData< dim >, Functions::InterpolatedUniformGridData< dim >, Functions::Polynomial< dim >, Functions::Spherical< dim >, Functions::SymbolicFunction< dim, RangeNumberType >, Functions::FEFieldFunction< dim, VectorType, spacedim >, Functions::CoordinateRestriction< dim >, Functions::SignedDistance::Sphere< dim >, and NonMatching::internal::DiscreteQuadratureGeneratorImplementation::RefSpaceFEFieldFunction< dim, VectorType >.
|
virtualinherited |
Return the gradient of all components of the function at the given point.
Reimplemented in Functions::ConstantFunction< dim, RangeNumberType >, and Functions::FEFieldFunction< dim, VectorType, spacedim >.
|
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::FEFieldFunction< dim, VectorType, spacedim >, and Functions::ConstantFunction< dim, RangeNumberType >.
|
virtualinherited |
Compute the Laplacian of a given component at point p.
Reimplemented in Functions::CosineGradFunction< dim >, Functions::IdentityFunction< dim, RangeNumberType >, Functions::CSpline< dim >, Functions::SquareFunction< dim >, Functions::Q1WedgeFunction< dim >, Functions::PillowFunction< dim >, Functions::CosineFunction< dim >, Functions::ExpFunction< dim >, Functions::SlitSingularityFunction< dim >, Functions::JumpFunction< dim >, Functions::FourierCosineFunction< dim >, Functions::FourierSineFunction< dim >, Functions::FourierSineSum< dim >, Functions::FourierCosineSum< dim >, Functions::SymbolicFunction< dim, RangeNumberType >, Functions::FEFieldFunction< dim, VectorType, spacedim >, Functions::ConstantFunction< dim, RangeNumberType >, and Functions::ConstantFunction< dim, double >.
|
virtualinherited |
Compute the Laplacian of all components at point p and store them in values.
Reimplemented in Functions::FEFieldFunction< dim, VectorType, spacedim >.
|
virtualinherited |
Compute the Laplacian of one component at a set of points.
Reimplemented in Functions::FEFieldFunction< dim, VectorType, spacedim >.
|
virtualinherited |
Compute the Hessian of a given component at point p, that is the gradient of the gradient of the function.
Reimplemented in Functions::SignedDistance::Plane< dim >, Functions::IdentityFunction< dim, RangeNumberType >, Functions::CSpline< dim >, Functions::CosineFunction< dim >, Functions::Spherical< dim >, Functions::SymbolicFunction< dim, RangeNumberType >, Functions::CoordinateRestriction< dim >, Functions::ConstantFunction< dim, RangeNumberType >, Functions::ConstantFunction< dim, double >, Functions::SignedDistance::Sphere< dim >, and NonMatching::internal::DiscreteQuadratureGeneratorImplementation::RefSpaceFEFieldFunction< dim, VectorType >.
|
virtualinherited |
Compute the Hessian of all components at point p and store them in values.
|
virtualinherited |
Compute the Hessian of one component at a set of points.
|
virtualinherited |
Compute the Hessians of all components at a set of points.
|
inherited |
Return the value of the time variable.
|
virtualinherited |
Set the time to new_time, overwriting the old value.
|
virtualinherited |
Advance the time by the given time step delta_t.
|
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.
|
inherited |
Unsubscribes a user from the object.
identifier and the validity pointer must be the same as the one supplied to subscribe(). Definition at line 156 of file subscriptor.cc.
|
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.
|
inlineinherited |
List the subscribers to the input stream.
Definition at line 317 of file subscriptor.h.
|
inherited |
List the subscribers to deallog.
Definition at line 204 of file subscriptor.cc.
|
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.
|
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.
Definition at line 53 of file subscriptor.cc.
|
private |
The viscosity.
Definition at line 224 of file flow_function.h.
|
private |
The reaction parameter.
Definition at line 226 of file flow_function.h.
|
protectedinherited |
Mean value of the pressure to be added by derived classes.
Definition at line 127 of file flow_function.h.
|
mutableprivateinherited |
A mutex that guards the following scratch arrays.
Definition at line 133 of file flow_function.h.
|
mutableprivateinherited |
Auxiliary values for the usual Function interface.
Definition at line 138 of file flow_function.h.
|
mutableprivateinherited |
Auxiliary values for the usual Function interface.
Definition at line 143 of file flow_function.h.
|
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.
|
inherited |
Number of vector components.
Definition at line 164 of file function.h.
|
privateinherited |
Store the present time.
Definition at line 113 of file function_time.h.
|
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 219 of file subscriptor.h.
|
mutableprivateinherited |
In this map, we count subscriptions for each different identification string supplied to subscribe().
Definition at line 225 of file subscriptor.h.
|
mutableprivateinherited |
In this vector, we store pointers to the validity bool in the SmartPointer objects that subscribe to this class.
Definition at line 241 of file subscriptor.h.
|
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 249 of file subscriptor.h.
1.9.7