Reference documentation for deal.II version SVN Revision 32792
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Protected Attributes | Private Attributes | List of all members
Functions::FlowFunction< dim > Class Template Referenceabstract

#include <flow_function.h>

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

Public Member Functions

 FlowFunction ()
 
virtual ~FlowFunction ()
 
void pressure_adjustment (double p)
 
virtual void vector_values (const std::vector< Point< dim > > &points, std::vector< std::vector< double > > &values) const =0
 
virtual void vector_gradients (const std::vector< Point< dim > > &points, std::vector< std::vector< Tensor< 1, dim > > > &gradients) const =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
 
virtual double value (const Point< dim > &points, const unsigned int component) const
 
virtual void vector_value_list (const std::vector< Point< dim > > &points, std::vector< Vector< double > > &values) const
 
virtual void vector_gradient_list (const std::vector< Point< dim > > &points, std::vector< std::vector< Tensor< 1, dim > > > &gradients) const
 
virtual void vector_laplacian_list (const std::vector< Point< dim > > &points, std::vector< Vector< double > > &values) const
 
std::size_t memory_consumption () const
 
- Public Member Functions inherited from Function< dim >
 Function (const unsigned int n_components=1, const double initial_time=0.0)
 
virtual ~Function ()=0
 
Functionoperator= (const Function &f)
 
virtual void value_list (const std::vector< Point< dim > > &points, std::vector< double > &values, const unsigned int component=0) const
 
virtual Tensor< 1, dim > gradient (const Point< dim > &p, const unsigned int component=0) const
 
virtual void vector_gradient (const Point< dim > &p, std::vector< Tensor< 1, dim > > &gradients) const
 
virtual void gradient_list (const std::vector< Point< dim > > &points, std::vector< Tensor< 1, dim > > &gradients, const unsigned int component=0) 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
 
std::size_t memory_consumption () const
 
- Public Member Functions inherited from FunctionTime
 FunctionTime (const double initial_time=0.0)
 
virtual ~FunctionTime ()
 
double get_time () const
 
virtual void set_time (const double new_time)
 
virtual void advance_time (const double delta_t)
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
void subscribe (const char *identifier=0) const
 
void unsubscribe (const char *identifier=0) const
 
unsigned int n_subscriptions () const
 
void list_subscribers () const
 
 DeclException3 (ExcInUse, int, char *, std::string &,<< "Object of class "<< arg2<< " is still used by "<< arg1<< " other objects.\n"<< "(Additional information: "<< arg3<< ")\n"<< "Note the entry in the Frequently Asked Questions of "<< "deal.II (linked to from http://www.dealii.org/) for "<< "more information on what this error means.")
 
 DeclException2 (ExcNoSubscriber, char *, char *,<< "No subscriber with identifier \""<< arg2<< "\" did subscribe to this object of class "<< arg1)
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

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
 

Additional Inherited Members

- Public Attributes inherited from Function< dim >
const unsigned int n_components
 
- Static Public Attributes inherited from Function< dim >
static const unsigned int dimension = dim
 

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.
Author
Guido Kanschat, 2007

Definition at line 50 of file flow_function.h.

Constructor & Destructor Documentation

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

Constructor, setting up some internal data structures.

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

Virtual destructor.

Member Function Documentation

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.

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

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

Reimplemented from Function< dim >.

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

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
pure virtual

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

Reimplemented from Function< dim >.

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

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

template<int dim>
virtual void Functions::FlowFunction< dim >::vector_value ( const Point< dim > &  p,
Vector< double > &  values 
) const
virtual

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 from Function< dim >.

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

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

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

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 from Function< dim >.

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

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 from Function< dim >.

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

The force term in the momentum equation.

Reimplemented from Function< dim >.

Member Data Documentation

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

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

Definition at line 130 of file flow_function.h.

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

A mutex that guards the following scratch arrays.

Definition at line 138 of file flow_function.h.

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

Auxiliary values for the usual Function interface.

Definition at line 144 of file flow_function.h.

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 150 of file flow_function.h.


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