.\"
.de Id
..
.de Sp
.if n .sp
.if t .sp 0.4
..
.TH quadrature_option 2rheolef "rheolef-7.0" "rheolef-7.0" "rheolef-7.0"
.\" label: /*Class:quadrature
.SH NAME
\fBquadrature_option\fP - send options to the integrate function
.\" skip: @cindex  quadrature formulae
.\" skip: @clindex quadrature
.\" skip: @clindex reference_element
.SH SYNOPSIS

The \fBquadrature_option\fP class is used to send options to
the \fBintegrate\fP function see integrate(4).
This class allows one to set the family (Gauss, Gauss-Lobatto, etc)
and the polynomial degree that is exactly integrated.
.PP
A special family name, call \fBequispaced\fP, refers to an equispaced
set of point, suitable for some irregular functions, e.g. the Heaviside function.
In that case, the \fBorder\fP parameter refers to the number of
nodes  used.
For instance, \fBorder=1\fP refers to the trapezoidal formulae
and for the general case, there are \fBorder+1\fP nodes per edges.
See also the see quadrature(2) for more on quadrature formulae.
.\" END
.SH IMPLEMENTATION
.\" begin_example
.Sp
.nf
class quadrature_option {
public:
// typedefs:

  typedef size_t size_type;

  typedef enum {
        gauss           = 0,
        gauss_lobatto   = 1,
        gauss_radau     = 2,
        middle_edge     = 3,
        superconvergent = 4,
        equispaced      = 5,
        max_family      = 6
  } family_type; // update also family_name[] in quatrature.cc

// allocators:

  quadrature_option(
        family_type ft = quadrature_option::gauss,
        size_type k = std::numeric_limits<size_type>::max());

  quadrature_option (const quadrature_option& qopt);
  quadrature_option& operator= (const quadrature_option& qopt);

// accessors & modifiers:

  size_t         get_order() const;
  family_type    get_family() const;
  std::string    get_family_name() const;
  void set_order (size_t r);
  void set_family (family_type type);
  void set_family (std::string name);
// data:
protected:
  family_type   _family;
  size_t        _order;
};
.Sp
.fi
.\" end_example

.\" LENGTH = 2
.SH SEE ALSO
integrate(4), quadrature(2)
.SH COPYRIGHT
Copyright (C) 2000-2018 Pierre Saramito <Pierre.Saramito@imag.fr> GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
This is free software: you are free to change and redistribute it.  There is NO WARRANTY, to the extent permitted by law.