Reference documentation for deal.II version Git 283ce71 2014-12-19 22:22:25 +0100
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Private Attributes | List of all members
hp::QCollection< dim > Class Template Reference

#include <deal.II/hp/q_collection.h>

Inheritance diagram for hp::QCollection< dim >:
[legend]

Public Member Functions

 QCollection ()
 
 QCollection (const Quadrature< dim > &quadrature)
 
 QCollection (const QCollection< dim > &q_collection)
 
void push_back (const Quadrature< dim > &new_quadrature)
 
const Quadrature< dim > & operator[] (const unsigned int index) const
 
unsigned int size () const
 
unsigned int max_n_quadrature_points () const
 
std::size_t memory_consumption () const
 
 DeclException0 (ExcNoQuadrature)
 
- 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)
 

Private Attributes

std::vector
< std_cxx11::shared_ptr< const
Quadrature< dim > > > 
quadratures
 

Detailed Description

template<int dim>
class hp::QCollection< dim >

This class implements a collection of quadrature objects in the same way as the hp::FECollection implements a collection of finite element classes.

It implements the concepts stated in the hp Collections module described in the doxygen documentation.

Author
Oliver Kayser-Herold, 2005

Definition at line 45 of file q_collection.h.

Constructor & Destructor Documentation

template<int dim>
hp::QCollection< dim >::QCollection ( )
inline

Default constructor. Leads to an empty collection that can later be filled using push_back().

Definition at line 168 of file q_collection.h.

template<int dim>
hp::QCollection< dim >::QCollection ( const Quadrature< dim > &  quadrature)
inlineexplicit

Conversion constructor. This constructor creates a QCollection from a single quadrature rule. More quadrature formulas can be added with push_back(), if desired, though it would probably be clearer to add all mappings the same way.

Definition at line 175 of file q_collection.h.

template<int dim>
hp::QCollection< dim >::QCollection ( const QCollection< dim > &  q_collection)
inline

Copy constructor.

Definition at line 186 of file q_collection.h.

Member Function Documentation

template<int dim>
void hp::QCollection< dim >::push_back ( const Quadrature< dim > &  new_quadrature)
inline

Adds a new quadrature rule to the QCollection. The quadrature rules have to be added in the same order as for the FECollection for which this quadrature rule collection is meant. Thus the reference to the quadrature rule for active_fe_index 0 has to be added first, followed by the quadrature rule for active_fe_index 1.

This class creates a copy of the given quadrature object, i.e. you can do things like push_back(QGauss<dim>(3));. The internal copy is later destroyed by this object upon destruction of the entire collection.

Definition at line 218 of file q_collection.h.

template<int dim>
const Quadrature< dim > & hp::QCollection< dim >::operator[] ( const unsigned int  index) const
inline

Returns a reference to the quadrature rule specified by the argument.

Precondition
index must be between zero and the number of elements of the collection.

Definition at line 157 of file q_collection.h.

template<int dim>
unsigned int hp::QCollection< dim >::size ( ) const
inline

Returns the number of quadrature pointers stored in this object.

Definition at line 129 of file q_collection.h.

template<int dim>
unsigned int hp::QCollection< dim >::max_n_quadrature_points ( ) const
inline

Return the maximum number of quadrature points over all the elements of the collection. This is mostly useful to initialize arrays to allocate the maxmimum amount of memory that may be used when re-sizing later on to a articular quadrature formula from within this collection.

Definition at line 139 of file q_collection.h.

template<int dim>
std::size_t hp::QCollection< dim >::memory_consumption ( ) const
inline

Determine an estimate for the memory consumption (in bytes) of this object.

Definition at line 208 of file q_collection.h.

template<int dim>
hp::QCollection< dim >::DeclException0 ( ExcNoQuadrature  )

Exception

Member Data Documentation

template<int dim>
std::vector<std_cxx11::shared_ptr<const Quadrature<dim> > > hp::QCollection< dim >::quadratures
private

The real container, which stores pointers to the different quadrature objects.

Definition at line 119 of file q_collection.h.


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