deal2lkit: A ToolKit library for Deal.II
ParsedQuadrature< dim > Class Template Reference

A deal2lkit wrapper for an iterated version of dealii::QuadratureSelector. More...

#include <parsed_quadrature.h>

Inheritance diagram for ParsedQuadrature< dim >:
Quadrature< dim > ParameterAcceptor Subscriptor Subscriptor

Public Member Functions

 ParsedQuadrature (const std::string &name="", const std::string &quadrature_type="gauss", const unsigned int order=3, const unsigned int repetitions=1)
 Constructor: takes an optional name for the section. More...
 
virtual void declare_parameters (ParameterHandler &prm)
 Declare quadrature type and quadrature options. More...
 
virtual void parse_parameters_call_back ()
 Fill information about blocks after parsing the parameters. More...
 
- Public Member Functions inherited from Quadrature< dim >
 Quadrature (const unsigned int n_quadrature_points=0)
 
 Quadrature (const SubQuadrature &, const Quadrature< 1 > &)
 
 Quadrature (const Quadrature< dim!=1?1:0 > &quadrature_1d)
 
 Quadrature (const Quadrature< dim > &q)
 
 Quadrature (Quadrature< dim > &&)=default
 
 Quadrature (const std::vector< Point< dim > > &points, const std::vector< double > &weights)
 
 Quadrature (const std::vector< Point< dim > > &points)
 
 Quadrature (const Point< dim > &point)
 
virtual ~Quadrature ()
 
Quadratureoperator= (const Quadrature< dim > &)
 
bool operator== (const Quadrature< dim > &p) const
 
void initialize (const std::vector< Point< dim > > &points, const std::vector< double > &weights)
 
unsigned int size () const
 
const Point< dim > & point (const unsigned int i) const
 
const std::vector< Point< dim > > & get_points () const
 
double weight (const unsigned int i) const
 
const std::vector< double > & get_weights () const
 
std::size_t memory_consumption () const
 
void serialize (Archive &ar, const unsigned int version)
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
 Subscriptor (Subscriptor &&)
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&)
 
void subscribe (const char *identifier=0) const
 
void unsubscribe (const char *identifier=0) const
 
unsigned int n_subscriptions () const
 
void list_subscribers () const
 
void serialize (Archive &ar, const unsigned int version)
 
- Public Member Functions inherited from ParameterAcceptor
 ParameterAcceptor (const std::string section_name="")
 The constructor adds derived classes to the list of acceptors. More...
 
virtual ~ParameterAcceptor ()
 The destructor sets to zero the pointer relative to this index, so that it is safe to destroy the mother class. More...
 
virtual void parse_parameters (ParameterHandler &prm)
 Parse the parameter file. More...
 
std::string get_section_name () const
 Return the section name of this class. More...
 
std::vector< std::string > get_section_path () const
 Travers all registered classes, and figure out what subsections we need to enter. More...
 
template<class T >
void add_parameter (ParameterHandler &prm, T *parameter, const std::string &entry, const std::string &default_value, const Patterns::PatternBase &pattern=Patterns::Anything(), const std::string &documentation=std::string())
 Add a parameter the given parameter list. More...
 
template<class T >
void add_parameter (T &parameter, const std::string &entry, const std::string &documentation=std::string(), ParameterHandler &prm=ParameterAcceptor::prm)
 Add a parameter to the global parameter handler ParameterAcceptor::prm. More...
 
void enter_my_subsection (ParameterHandler &prm)
 Make sure we enter the right subsection of the global parameter file. More...
 
void leave_my_subsection (ParameterHandler &prm)
 This function undoes what the enter_my_subsection() function did. More...
 
template<>
std_cxx11::shared_ptr< Patterns::PatternBaseto_pattern (const double &)
 double More...
 
template<>
std::string to_string (const double &entry)
 
template<>
double to_type (const std::string &parameter)
 
template<>
std_cxx11::shared_ptr< Patterns::PatternBaseto_pattern (const int &)
 int More...
 
template<>
std::string to_string (const int &entry)
 
template<>
int to_type (const std::string &parameter)
 
template<>
std_cxx11::shared_ptr< Patterns::PatternBaseto_pattern (const unsigned int &)
 unsigned int More...
 
template<>
std::string to_string (const unsigned int &entry)
 
template<>
unsigned int to_type (const std::string &parameter)
 
template<>
std_cxx11::shared_ptr< Patterns::PatternBaseto_pattern (const bool &)
 bool More...
 
template<>
std::string to_string (const bool &entry)
 
template<>
bool to_type (const std::string &parameter)
 

Private Attributes

std::string quadrature_type
 Name of the quadrature of the quadrature rule: "gauss", "midpoint", "milne", "simpson", "trapez", or "weddle". More...
 
unsigned int repetitions
 In one space dimension, the given base formula is copied and scaled onto a given number of subintervals of length 1/repetitions. More...
 
unsigned int order
 Number of quadrature points in each coordinate direction. More...
 

Additional Inherited Members

- Public Types inherited from Quadrature< dim >
typedef Quadrature< dim-1 > SubQuadrature
 
- Static Public Member Functions inherited from Subscriptor
static::ExceptionBase & ExcInUse (int arg1, char *arg2, std::string &arg3)
 
static::ExceptionBase & ExcNoSubscriber (char *arg1, char *arg2)
 
- Static Public Member Functions inherited from ParameterAcceptor
static void initialize (const std::string filename="", const std::string outfilename="")
 Call declare_all_parameters(), read filename (if it is present as input parameter) and parse_all_parameters() on the static member prm. More...
 
static void clear ()
 Clear class list and global parameter file. More...
 
static void parse_all_parameters (ParameterHandler &prm=ParameterAcceptor::prm)
 Parse the given ParameterHandler. More...
 
static void log_info ()
 Print information about all stored classes. More...
 
static void declare_all_parameters (ParameterHandler &prm=ParameterAcceptor::prm)
 Initialize the ParameterHandler with all derived classes parameters.This function enters the subsection returned by get_section_name() for each derived class, and declares all parameters that were added using add_parameter(). More...
 
template<class T >
static std_cxx11::shared_ptr< Patterns::PatternBaseto_pattern (const T &)
 Given a class T, construct its default pattern to be used when declaring parameters. More...
 
template<class T >
static T to_type (const std::string &)
 Given a string, fill the value of the given parameter. More...
 
template<class T >
static std::string to_string (const T &)
 Given a parameter, return a string containing the given parameter. More...
 
- Static Public Attributes inherited from ParameterAcceptor
static ParameterHandler prm
 Static parameter. More...
 
- Protected Attributes inherited from Quadrature< dim >
std::vector< Point< dim > > quadrature_points
 
std::vector< double > weights
 
- Protected Attributes inherited from ParameterAcceptor
const std::string section_name
 The subsection name for this class. More...
 

Detailed Description

template<int dim>
class ParsedQuadrature< dim >

A deal2lkit wrapper for an iterated version of dealii::QuadratureSelector.

The template integer specifies the dimension of the quadrature.

Definition at line 33 of file parsed_quadrature.h.

Constructor & Destructor Documentation

§ ParsedQuadrature()

template<int dim>
ParsedQuadrature< dim >::ParsedQuadrature ( const std::string &  name = "",
const std::string &  quadrature_type = "gauss",
const unsigned int  order = 3,
const unsigned int  repetitions = 1 
)

Constructor: takes an optional name for the section.

Moreover, it Takes the name of the quadrature rule quadrature_type that could be chosen among following names:

  • gauss;
  • midpoint;
  • milne;
  • simpson;
  • trapez;
  • weddle; If quadrature_type is "gauss" it is possible to specify the number of quadrature points in each coordinate direction (order).

The last parameter specify how many times this quadrature should be repeated, i.e., in one space dimension, the given base formula is copied and scaled onto a given number of subintervals of length 1/repetitions. In more than one space dimension, the resulting quadrature formula is constructed by tensor product of the respective iterated quadrature formula in one space dimension.

Definition at line 23 of file parsed_quadrature.cc.

Member Function Documentation

§ declare_parameters()

template<int dim>
void ParsedQuadrature< dim >::declare_parameters ( ParameterHandler prm)
virtual

Declare quadrature type and quadrature options.

Reimplemented from ParameterAcceptor.

Definition at line 37 of file parsed_quadrature.cc.

§ parse_parameters_call_back()

template<int dim>
void ParsedQuadrature< dim >::parse_parameters_call_back ( )
virtual

Fill information about blocks after parsing the parameters.

Reimplemented from ParameterAcceptor.

Definition at line 62 of file parsed_quadrature.cc.

Member Data Documentation

§ order

template<int dim>
unsigned int ParsedQuadrature< dim >::order
private

Number of quadrature points in each coordinate direction.

This variable is only valid for gauss rule.

Definition at line 93 of file parsed_quadrature.h.

§ quadrature_type

template<int dim>
std::string ParsedQuadrature< dim >::quadrature_type
private

Name of the quadrature of the quadrature rule: "gauss", "midpoint", "milne", "simpson", "trapez", or "weddle".

Definition at line 78 of file parsed_quadrature.h.

§ repetitions

template<int dim>
unsigned int ParsedQuadrature< dim >::repetitions
private

In one space dimension, the given base formula is copied and scaled onto a given number of subintervals of length 1/repetitions.

In more than one space dimension, the resulting quadrature formula is constructed in the usual way by building the tensor product of the respective iterated quadrature formula in one space dimension.

Definition at line 87 of file parsed_quadrature.h.


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