Reference documentation for deal.II version Git d4ec8156ca 2019-11-18 14:03:00 -0700
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Member Functions | Static 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)
 
virtual ~LocalIntegrator () override=default
 
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
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
 Subscriptor (Subscriptor &&) noexcept
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&) noexcept
 
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)
 

Static Public Member Functions

static ::ExceptionBaseExcPureFunction ()
 
- Static Public Member Functions inherited from Subscriptor
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 

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 58 of file local_integrator.h.

Constructor & Destructor Documentation

◆ LocalIntegrator() [1/2]

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 61 of file mesh_worker.cc.

◆ LocalIntegrator() [2/2]

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.

◆ ~LocalIntegrator()

template<int dim, int spacedim = dim, typename number = double>
virtual MeshWorker::LocalIntegrator< dim, spacedim, number >::~LocalIntegrator ( )
overridevirtualdefault

The empty virtual destructor.

Member Function Documentation

◆ cell()

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.

◆ boundary()

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 91 of file mesh_worker.cc.

◆ face()

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 101 of file mesh_worker.cc.

Member Data Documentation

◆ use_cell

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 105 of file local_integrator.h.

◆ use_boundary

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 111 of file local_integrator.h.

◆ use_face

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 117 of file local_integrator.h.

◆ input_vector_names

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 127 of file local_integrator.h.

◆ output_names

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 137 of file local_integrator.h.


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