Classes | |
class | ExcCellNotActiveForCellData |
class | ExcInvalidNumberOfSubdivisions |
Public Types | |
typedef DataOut_DoFData< DH, DH::dimension-1, DH::dimension > ::cell_iterator | cell_iterator |
typedef std::pair < cell_iterator, unsigned int > | FaceDescriptor |
Public Member Functions | |
virtual void | build_patches (const unsigned int n_subdivisions=0, const unsigned int n_threads=multithread_info.n_default_threads) |
virtual FaceDescriptor | first_face () |
virtual FaceDescriptor | next_face (const FaceDescriptor &face) |
Private Member Functions | |
void | build_some_patches (internal::DataOut::ParallelData< DH::dimension, DH::dimension > &data) |
The interface of this class is copied from the DataOut class. Furthermore, they share the common parent class DataOut_DoFData. See the reference of these two classes for a discussion of the interface.
The sequence of faces to generate patches from is generated in the same way as in the DataOut class, see there for a description of the respective interface. For obvious reasons, the functions generating the sequence of faces which shall be used to generate output, are called first_face
and next_face
in this class, rather than first_cell
and next_cell
.
Since we need to initialize objects of type FEValues with the faces generated from these functions, it is not sufficient that they only return face iterators. Rather, we need a pair of cell and the number of the face, as the values of finite element fields need not necessarily be unique on a face (think of discontinuous finite elements, where the value of the finite element field depend on the direction from which you approach a face, thus it is necessary to use a pair of cell and face, rather than only a face iterator). Therefore, this class defines a typedef
which creates a type FaceDescriptor
that is an abbreviation for a pair of cell iterator and face number. The functions first_face
and next_face
operate on objects of this type.
Extending this class might, for example, be useful if you only want output from certain portions of the boundary, e.g. as indicated by the boundary indicator of the respective faces. However, it is also conceivable that one generates patches not from boundary faces, but from interior faces that are selected due to other criteria; one application might be to use only those faces where one component of the solution attains a certain value, in order to display the values of other solution components on these faces. Other applications certainly exist, for which the author is not imaginative enough.
typedef DataOut_DoFData<DH,DH::dimension-1, DH::dimension>::cell_iterator DataOutFaces< dim, DH >::cell_iterator |
Typedef to the iterator type of the dof handler class under consideration.
Reimplemented from DataOut_DoFData< DH, DH::dimension-1, DH::dimension >.
typedef std::pair<cell_iterator,unsigned int> DataOutFaces< dim, DH >::FaceDescriptor |
Declare a way to describe a face which we would like to generate output for. The usual way would, of course, be to use an object of type DoFHandler<dim>::face_iterator
, but since we have to describe faces to objects of type FEValues, we can only represent faces by pairs of a cell and the number of the face. This pair is here aliased to a name that is better to type.
virtual void DataOutFaces< dim, DH >::build_patches | ( | const unsigned int | n_subdivisions = 0 , |
|
const unsigned int | n_threads = multithread_info.n_default_threads | |||
) | [virtual] |
This is the central function of this class since it builds the list of patches to be written by the low-level functions of the base class. See the general documentation of this class for further information.
The function supports multithreading, if deal.II is compiled in multithreading mode. The default number of threads to be used to build the patches is set to multithread_info.n_default_threads
.
virtual FaceDescriptor DataOutFaces< dim, DH >::first_face | ( | ) | [virtual] |
Return the first face which we want output for. The default implementation returns the first active face on the boundary, but you might want to return another face in a derived class.
virtual FaceDescriptor DataOutFaces< dim, DH >::next_face | ( | const FaceDescriptor & | face | ) | [virtual] |
Return the next face after face
which we want output for. If there are no more face, dofs->end()
shall be returned as the first component of the return value.
The default implementation returns the next active face on the boundary, but you might want to return other faces in a derived class. Note that the default implementation assumes that the given face
is active, which is guaranteed as long as first_face
is also used from the default implementation. Overloading only one of the two functions might not be a good idea.
void DataOutFaces< dim, DH >::build_some_patches | ( | internal::DataOut::ParallelData< DH::dimension, DH::dimension > & | data | ) | [private] |
Builds every n_threads's
patch. This function may be called in parallel. If multithreading is not used, the function is called once and generates all patches.