Reference documentation for deal.II version 8.4.1
Public Member Functions | Public Attributes | List of all members
MeshWorker::LocalIntegrator< dim, spacedim, number > Class Template Reference

#include <deal.II/meshworker/local_integrator.h>

Inheritance diagram for MeshWorker::LocalIntegrator< dim, spacedim, number >:
[legend]

Public Member Functions

 LocalIntegrator ()
 
 LocalIntegrator (bool use_cell, bool use_boundary, bool use_face)
 
 ~LocalIntegrator ()
 
virtual void cell (DoFInfo< dim, spacedim, number > &dinfo, IntegrationInfo< dim, spacedim > &info) const
 
virtual void boundary (DoFInfo< dim, spacedim, number > &dinfo, IntegrationInfo< dim, spacedim > &info) const
 
virtual void face (DoFInfo< dim, spacedim, number > &dinfo1, DoFInfo< dim, spacedim, number > &dinfo2, IntegrationInfo< dim, spacedim > &info1, IntegrationInfo< dim, spacedim > &info2) const
 
 DeclException0 (ExcPureFunction)
 
- 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\n"<< "(Additional information: "<< arg3<< ")\n\n"<< "See the entry in the Frequently Asked Questions of "<< "deal.II (linked to from http://www.dealii.org/) for "<< "a lot more information on what this error means and "<< "how to fix programs in which it happens.")
 
 DeclException2 (ExcNoSubscriber, char *, char *,<< "No subscriber with identifier <"<< arg2<< "> subscribes to this object of class "<< arg1<< ". Consequently, it cannot be unsubscribed.")
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Public Attributes

bool use_cell
 
bool use_boundary
 
bool use_face
 
std::vector< std::string > input_vector_names
 
std::vector< std::string > output_names
 

Detailed Description

template<int dim, int spacedim = dim, typename number = double>
class MeshWorker::LocalIntegrator< dim, spacedim, number >

A local integrator object, which can be used to simplify the call of loop(). Instead of providing the three local integration functions separately, we bundle them as virtual functions in this class.

Additionally, since we cannot have a virtual null function, we provide flags, which allow us to indicate, whether we want to integrate on boundary and interior faces. These flags are true by default, but can be modified by applications to speed up the loop.

If a function is not overloaded in a derived class, but its usage flag is true, the function will cause an exception ExcPureFunction.

Author
Guido Kanschat
Date
2012

Definition at line 52 of file local_integrator.h.

Constructor & Destructor Documentation

template<int dim, int spacedim, typename number >
MeshWorker::LocalIntegrator< dim, spacedim, number >::LocalIntegrator ( )

The constructor setting default values, namely all integration flags to true.

Definition at line 62 of file mesh_worker.cc.

template<int dim, int spacedim, typename number >
MeshWorker::LocalIntegrator< dim, spacedim, number >::LocalIntegrator ( bool  use_cell,
bool  use_boundary,
bool  use_face 
)

The constructor setting integration flags to specified values.

Definition at line 69 of file mesh_worker.cc.

template<int dim, int spacedim, typename number >
MeshWorker::LocalIntegrator< dim, spacedim, number >::~LocalIntegrator ( )

The empty virtual destructor.

Definition at line 76 of file mesh_worker.cc.

Member Function Documentation

template<int dim, int spacedim, typename number >
void MeshWorker::LocalIntegrator< dim, spacedim, number >::cell ( DoFInfo< dim, spacedim, number > &  dinfo,
IntegrationInfo< dim, spacedim > &  info 
) const
virtual

Virtual function for integrating on cells. Throws exception PureFunctionCalled if not overloaded by a derived class.

Definition at line 81 of file mesh_worker.cc.

template<int dim, int spacedim, typename number >
void MeshWorker::LocalIntegrator< dim, spacedim, number >::boundary ( DoFInfo< dim, spacedim, number > &  dinfo,
IntegrationInfo< dim, spacedim > &  info 
) const
virtual

Virtual function for integrating on boundary faces. Throws exception PureFunctionCalled if not overloaded by a derived class.

Definition at line 90 of file mesh_worker.cc.

template<int dim, int spacedim, typename number >
void MeshWorker::LocalIntegrator< dim, spacedim, number >::face ( DoFInfo< dim, spacedim, number > &  dinfo1,
DoFInfo< dim, spacedim, number > &  dinfo2,
IntegrationInfo< dim, spacedim > &  info1,
IntegrationInfo< dim, spacedim > &  info2 
) const
virtual

Virtual function for integrating on interior faces. Throws exception PureFunctionCalled if not overloaded by a derived class.

Definition at line 99 of file mesh_worker.cc.

Member Data Documentation

template<int dim, int spacedim = dim, typename number = double>
bool MeshWorker::LocalIntegrator< dim, spacedim, number >::use_cell

The flag indicating whether the cell integrator cell() is to be used in the loop. Defaults to true.

Definition at line 96 of file local_integrator.h.

template<int dim, int spacedim = dim, typename number = double>
bool MeshWorker::LocalIntegrator< dim, spacedim, number >::use_boundary

The flag indicating whether the boundary integrator boundary() is to be used in the loop. Defaults to true.

Definition at line 102 of file local_integrator.h.

template<int dim, int spacedim = dim, typename number = double>
bool MeshWorker::LocalIntegrator< dim, spacedim, number >::use_face

The flag indicating whether the interior face integrator face() is to be used in the loop. Defaults to true.

Definition at line 108 of file local_integrator.h.

template<int dim, int spacedim = dim, typename number = double>
std::vector<std::string> MeshWorker::LocalIntegrator< dim, spacedim, number >::input_vector_names

The names of the input vectors. If this vector is nonempty, it can be used by application programs to automatically select and verify the input vectors used for integration.

Note
This variable is currently not used by the library, but it is provided to help develop application programs.

Definition at line 118 of file local_integrator.h.

template<int dim, int spacedim = dim, typename number = double>
std::vector<std::string> MeshWorker::LocalIntegrator< dim, spacedim, number >::output_names

The names of the results produced. If this vector is nonempty, it can be used by application programs to automatically assign names to output values and/or verify the names of vectors.

Note
This variable is currently not used by the library, but it is provided to help develop application programs.

Definition at line 128 of file local_integrator.h.


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