![]() |
Reference documentation for deal.II version Git 54662f1c23 2021-02-26 09:51:10 -0500
|
#include <deal.II/base/quadrature_point_data.h>
Public Member Functions | |
CellDataStorage ()=default | |
~CellDataStorage () override=default | |
template<typename T = DataType> | |
void | initialize (const CellIteratorType &cell, const unsigned int number_of_data_points_per_cell) |
template<typename T = DataType> | |
void | initialize (const CellIteratorType &cell_start, const CellIteratorType &cell_end, const unsigned int number_of_data_points_per_cell) |
bool | erase (const CellIteratorType &cell) |
void | clear () |
template<typename T = DataType> | |
std::vector< std::shared_ptr< T > > | get_data (const CellIteratorType &cell) |
template<typename T = DataType> | |
std::vector< std::shared_ptr< const T > > | get_data (const CellIteratorType &cell) const |
template<typename T = DataType> | |
std_cxx17::optional< std::vector< std::shared_ptr< T > > > | try_get_data (const CellIteratorType &cell) |
template<typename T = DataType> | |
std_cxx17::optional< std::vector< std::shared_ptr< const T > > > | try_get_data (const CellIteratorType &cell) const |
template<class Archive > | |
void | serialize (Archive &ar, const unsigned int version) |
Subscriptor functionality | |
Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class. | |
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 |
Static Public Member Functions | |
static ::ExceptionBase & | ExcInUse (int arg1, std::string arg2, std::string arg3) |
static ::ExceptionBase & | ExcNoSubscriber (std::string arg1, std::string arg2) |
Static Private Member Functions | |
static ::ExceptionBase & | ExcCellDataTypeMismatch () |
static ::ExceptionBase & | ExcTriangulationMismatch () |
Private Attributes | |
SmartPointer< const Triangulation< dimension, space_dimension >, CellDataStorage< CellIteratorType, DataType > > | tria |
std::map< CellId, std::vector< std::shared_ptr< DataType > > > | map |
Static Private Attributes | |
static constexpr unsigned int | dimension |
static constexpr unsigned int | space_dimension |
A class for storing at each cell represented by iterators of type CellIteratorType
a vector of data DataType
. The underlying structure and the initialize() method of this class are designed in such a way that one could use different child classes derived from the base DataType class to store data on a given cell. This implies the usage of pointers, in our case – std::shared_ptr.
The type DataType
is arbitrary, but when using a class derived from TransferableQuadraturePointData one can use the facilities of parallel::distributed::ContinuousQuadratureDataTransfer.
Definition at line 62 of file quadrature_point_data.h.
|
default |
Default constructor.
|
overridedefault |
Default destructor.
void CellDataStorage< CellIteratorType, DataType >::initialize | ( | const CellIteratorType & | cell, |
const unsigned int | number_of_data_points_per_cell | ||
) |
Initialize data on the cell
to store number_of_data_points_per_cell
of objects of type T
. The typename T
is possibly another class which is derived from the base DataType
class. In order to initialize the vector of objects we have to assume that the class T
has a default constructor. This function has to be called on every cell where data is to be stored.
After the data is initialized, it can be modified using the get_data() function.
cell
will not alter the objects associated with it. In order to remove the stored data, use the erase() function.T
for different cells which may reflect, for example, different constitutive models of continuum mechanics in different parts of the domain.T
needs to either equal DataType
, or be a class derived from DataType
. T
needs to be default constructible. void CellDataStorage< CellIteratorType, DataType >::initialize | ( | const CellIteratorType & | cell_start, |
const CellIteratorType & | cell_end, | ||
const unsigned int | number_of_data_points_per_cell | ||
) |
Same as above but for a range of iterators starting at cell_start
until, but not including, cell_end
for all locally owned cells, i.e. for which cell->is_locally_owned()==true
.
bool CellDataStorage< CellIteratorType, DataType >::erase | ( | const CellIteratorType & | cell | ) |
Removes data stored at the cell
. Returns true if the data was removed. If no data is attached to the cell
, this function will not do anything and returns false.
void CellDataStorage< CellIteratorType, DataType >::clear | ( | ) |
Clear all the data stored in this object.
std::vector<std::shared_ptr<T> > CellDataStorage< CellIteratorType, DataType >::get_data | ( | const CellIteratorType & | cell | ) |
Get a vector of the data located at cell
. A possible additional typename T
is the class to which the base class DataType could be cast. Since DataType
is stored as shared pointers, there is minimal overhead in returning a vector by value instead of by reference. This allows flexibility if class T
is not the same as DataType
on a cell-by-cell basis.
T
needs to match the class provided to initialize() .cell
must be from the same Triangulation that is used to initialize() the cell data. std::vector<std::shared_ptr<const T> > CellDataStorage< CellIteratorType, DataType >::get_data | ( | const CellIteratorType & | cell | ) | const |
Get a vector of constant pointers to data located at cell
. A possible additional typename T
is the class to which the base class DataType could be cast. Since DataType
is stored as shared pointers, there is minimal overhead in returning a vector by value instead of by reference. This allows flexibility if class T
is not the same as DataType
on a cell-by-cell basis.
T
needs to match the class provided to initialize() .cell
must be from the same Triangulation that is used to initialize() the cell data. std_cxx17::optional<std::vector<std::shared_ptr<T> > > CellDataStorage< CellIteratorType, DataType >::try_get_data | ( | const CellIteratorType & | cell | ) |
Returns a std_cxx17::optional indicating whether cell
contains an associated data or not. If data is available, dereferencing the std_cxx17::optional reveals a vector of pointers to the underlying data at the quadrature points. A possible additional typename T
is the class to which the base class DataType could be cast. Since DataType
is stored as shared pointers, there is minimal overhead in returning a vector by value instead of by reference. This allows flexibility if class T
is not the same as DataType
on a cell-by-cell basis.
T
needs to match the class provided to initialize(). cell
must be from the same Triangulation that is used to initialize() the cell data. std_cxx17::optional<std::vector<std::shared_ptr<const T> > > CellDataStorage< CellIteratorType, DataType >::try_get_data | ( | const CellIteratorType & | cell | ) | const |
Returns a std_cxx17::optional indicating whether cell
contains an associated data or not. If data is available, dereferencing the std_cxx17::optional reveals a vector of constant pointers to the underlying data at the quadrature points. A possible additional typename T
is the class to which the base class DataType could be cast. Since DataType
is stored as shared pointers, there is minimal overhead in returning a vector by value instead of by reference. This allows flexibility if class T
is not the same as DataType
on a cell-by-cell basis.
T
needs to match the class provided to initialize(). cell
must be from the same Triangulation that is used to initialize() the cell data.
|
inherited |
Subscribes a user of the object by storing the pointer validity
. The subscriber may be identified by text supplied as identifier
.
Definition at line 136 of file subscriptor.cc.
|
inherited |
Unsubscribes a user from the object.
identifier
and the validity
pointer must be the same as the one supplied to subscribe(). Definition at line 156 of file subscriptor.cc.
|
inlineinherited |
Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.
Definition at line 301 of file subscriptor.h.
|
inlineinherited |
List the subscribers to the input stream
.
Definition at line 318 of file subscriptor.h.
|
inherited |
List the subscribers to deallog
.
Definition at line 204 of file subscriptor.cc.
|
inlineinherited |
Read or write the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.
This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.
Definition at line 310 of file subscriptor.h.
|
staticprivate |
Number of dimensions
Definition at line 214 of file quadrature_point_data.h.
|
staticprivate |
Number of space dimensions
Definition at line 220 of file quadrature_point_data.h.
|
private |
To ensure that all the cells in the CellDataStorage come from the same Triangulation, we need to store a reference to that Triangulation within the class.
Definition at line 230 of file quadrature_point_data.h.
|
private |
A map to store a vector of data on each cell. We need to use CellId as the key because it remains unique during adaptive refinement.
Definition at line 237 of file quadrature_point_data.h.