Reference documentation for deal.II version GIT 5dcc62ab57 2022-07-04 21:05:02+00:00
DataOutFaces< dim, spacedim > Class Template Reference

#include <deal.II/numerics/data_out_faces.h>

Inheritance diagram for DataOutFaces< dim, spacedim >:
[legend]

## Public Types

using cell_iterator = typename DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::cell_iterator

using FaceDescriptor = typename std::pair< cell_iterator, unsigned int >

enum  DataVectorType

## Public Member Functions

DataOutFaces (const bool surface_only=true)

virtual void build_patches (const unsigned int n_subdivisions=0)

virtual void build_patches (const Mapping< dim, spacedim > &mapping, const unsigned int n_subdivisions=0)

virtual FaceDescriptor first_face ()

virtual FaceDescriptor next_face (const FaceDescriptor &face)

void attach_dof_handler (const DoFHandler< dim, spacedim > &)

void attach_triangulation (const Triangulation< dim, spacedim > &)

void add_data_vector (const VectorType &data, const std::vector< std::string > &names, const DataVectorType type=type_automatic, const std::vector< DataComponentInterpretation::DataComponentInterpretation > &data_component_interpretation={})

void add_data_vector (const VectorType &data, const std::string &name, const DataVectorType type=type_automatic, const std::vector< DataComponentInterpretation::DataComponentInterpretation > &data_component_interpretation={})

void add_data_vector (const DoFHandler< dim, spacedim > &dof_handler, const VectorType &data, const std::vector< std::string > &names, const std::vector< DataComponentInterpretation::DataComponentInterpretation > &data_component_interpretation={})

void add_data_vector (const DoFHandler< dim, spacedim > &dof_handler, const VectorType &data, const std::string &name, const std::vector< DataComponentInterpretation::DataComponentInterpretation > &data_component_interpretation={})

void add_data_vector (const VectorType &data, const DataPostprocessor< spacedim > &data_postprocessor)

void add_data_vector (const DoFHandler< dim, spacedim > &dof_handler, const VectorType &data, const DataPostprocessor< spacedim > &data_postprocessor)

void add_mg_data_vector (const DoFHandler< dim, spacedim > &dof_handler, const MGLevelObject< VectorType > &data, const std::vector< std::string > &names, const std::vector< DataComponentInterpretation::DataComponentInterpretation > &data_component_interpretation=std::vector< DataComponentInterpretation::DataComponentInterpretation >())

void add_mg_data_vector (const DoFHandler< dim, spacedim > &dof_handler, const MGLevelObject< VectorType > &data, const std::string &name)

void clear_data_vectors ()

void clear_input_data_references ()

void merge_patches (const DataOut_DoFData< dim2, patch_dim, spacedim2, patch_spacedim > &source, const Point< patch_spacedim > &shift=Point< patch_spacedim >())

virtual void clear ()

std::size_t memory_consumption () const

virtual const std::vector< Patch > & get_patches () const override

void write_dx (std::ostream &out) const

void write_eps (std::ostream &out) const

void write_gmv (std::ostream &out) const

void write_gnuplot (std::ostream &out) const

void write_povray (std::ostream &out) const

void write_tecplot (std::ostream &out) const

void write_ucd (std::ostream &out) const

void write_vtk (std::ostream &out) const

void write_vtu (std::ostream &out) const

void write_vtu_in_parallel (const std::string &filename, const MPI_Comm &comm) const

void write_pvtu_record (std::ostream &out, const std::vector< std::string > &piece_names) const

std::string write_vtu_with_pvtu_record (const std::string &directory, const std::string &filename_without_extension, const unsigned int counter, const MPI_Comm &mpi_communicator, const unsigned int n_digits_for_counter=numbers::invalid_unsigned_int, const unsigned int n_groups=0) const

void write_svg (std::ostream &out) const

void write_deal_II_intermediate (std::ostream &out) const

XDMFEntry create_xdmf_entry (const DataOutBase::DataOutFilter &data_filter, const std::string &h5_filename, const double cur_time, const MPI_Comm &comm) const

XDMFEntry create_xdmf_entry (const DataOutBase::DataOutFilter &data_filter, const std::string &h5_mesh_filename, const std::string &h5_solution_filename, const double cur_time, const MPI_Comm &comm) const

void write_xdmf_file (const std::vector< XDMFEntry > &entries, const std::string &filename, const MPI_Comm &comm) const

void write_hdf5_parallel (const DataOutBase::DataOutFilter &data_filter, const std::string &filename, const MPI_Comm &comm) const

void write_hdf5_parallel (const DataOutBase::DataOutFilter &data_filter, const bool write_mesh_file, const std::string &mesh_filename, const std::string &solution_filename, const MPI_Comm &comm) const

void write_filtered_data (DataOutBase::DataOutFilter &filtered_data) const

void write (std::ostream &out, const DataOutBase::OutputFormat output_format=DataOutBase::default_format) const

void set_default_format (const DataOutBase::OutputFormat default_format)

template<typename FlagType >
void set_flags (const FlagType &flags)

std::string default_suffix (const DataOutBase::OutputFormat output_format=DataOutBase::default_format) const

void parse_parameters (ParameterHandler &prm)

## Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)

## Static Public Attributes

static constexpr int patch_dim = dim - 1

static constexpr int patch_spacedim = spacedim

## Protected Types

using Patch = ::DataOutBase::Patch< patch_dim, patch_spacedim >

## Protected Member Functions

virtual std::vector< std::string > get_dataset_names () const override

virtual std::vector< std::tuple< unsigned int, unsigned int, std::string, DataComponentInterpretation::DataComponentInterpretation > > get_nonscalar_data_ranges () const override

std::vector< std::shared_ptr<::hp::FECollection< dim, spacedim > > > get_fes () const

void validate_dataset_names () const

## Protected Attributes

SmartPointer< const Triangulation< dim, spacedim > > triangulation

SmartPointer< const DoFHandler< dim, spacedim > > dofs

std::vector< std::shared_ptr< internal::DataOutImplementation::DataEntryBase< dim, spacedim > > > dof_data

std::vector< std::shared_ptr< internal::DataOutImplementation::DataEntryBase< dim, spacedim > > > cell_data

std::vector< Patchpatches

unsigned int default_subdivisions

## Private Member Functions

void build_one_patch (const FaceDescriptor *cell_and_face, internal::DataOutFacesImplementation::ParallelData< dim, spacedim > &data, DataOutBase::Patch< patch_dim, patch_spacedim > &patch)

void add_data_vector_internal (const DoFHandler< dim, spacedim > *dof_handler, const VectorType &data, const std::vector< std::string > &names, const DataVectorType type, const std::vector< DataComponentInterpretation::DataComponentInterpretation > &data_component_interpretation, const bool deduce_output_names)

## Detailed Description

### template<int dim, int spacedim = dim> class DataOutFaces< dim, spacedim >

This class generates output from faces of a triangulation. It might be used to generate output only for the surface of the triangulation (this is the default of this class), or for all faces of active cells, as specified in the constructor. The output of this class is a set of patches (as defined by the class DataOutBase::Patch()), one for each face for which output is to be generated. These patches can then be written in several graphical data formats by the functions of the underlying classes.

### Interface

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.

### Extending this class

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. The functions generating the sequence of faces which shall be used to generate output, are called first_face() and next_face().

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 an alias 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.

Todo:
Reimplement this whole class using actual FEFaceValues and MeshWorker.

Definition at line 109 of file data_out_faces.h.

## ◆ cell_iterator

template<int dim, int spacedim = dim>
 using DataOutFaces< dim, spacedim >::cell_iterator = typename DataOut_DoFData:: cell_iterator

Alias to the iterator type of the dof handler class under consideration.

Definition at line 124 of file data_out_faces.h.

## ◆ FaceDescriptor

template<int dim, int spacedim = dim>
 using DataOutFaces< dim, spacedim >::FaceDescriptor = typename std::pair

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.

Definition at line 190 of file data_out_faces.h.

## ◆ Patch

 using DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::Patch = ::DataOutBase::Patch
protectedinherited

Abbreviate the somewhat lengthy name for the Patch class.

Definition at line 951 of file data_out_dof_data.h.

## ◆ DataVectorType

 inherited

Type describing what the vector given to add_data_vector() is: a vector that has one entry per degree of freedom in a DoFHandler object (such as solution vectors), or one entry per cell in the triangulation underlying the DoFHandler object (such as error per cell data). The value type_automatic tells add_data_vector() to find out itself (see the documentation of add_data_vector() for the method used).

Definition at line 615 of file data_out_dof_data.h.

## ◆ DataOutFaces()

template<int dim, int spacedim>
 DataOutFaces< dim, spacedim >::DataOutFaces ( const bool surface_only = true )

Constructor.

Parameters
 [in] surface_only If true, then this class only generates output on faces that lie on the boundary of the domain. This is typically what this class is used for: To output information about the solution, fluxes, and other quantities that live on the boundary of the domain. On the other hand, it is sometimes useful to also visualize data on internal faces. This is facilitated by setting this argument to false.

Definition at line 89 of file data_out_faces.cc.

## ◆ build_patches() [1/2]

template<int dim, int spacedim>
 void DataOutFaces< dim, spacedim >::build_patches ( const unsigned int n_subdivisions = 0 )
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. A patch is, in essence, some intermediate representation of the data on each face of a triangulation and DoFHandler object that can then be used to write files in some format that is readable by visualization programs.

You can find an overview of the use of this function in the general documentation of this class. An example is also provided in the documentation of this class's base class DataOut_DoFData.

Parameters
 n_subdivisions See DataOut::build_patches() for an extensive description of this parameter.

Definition at line 327 of file data_out_faces.cc.

## ◆ build_patches() [2/2]

template<int dim, int spacedim>
 void DataOutFaces< dim, spacedim >::build_patches ( const Mapping< dim, spacedim > & mapping, const unsigned int n_subdivisions = 0 )
virtual

Same as above, except that the additional first parameter defines a mapping that is to be used in the generation of output. If n_subdivisions>1, the points interior of subdivided patches which originate from cells at the boundary of the domain can be computed using the mapping, i.e. a higher order mapping leads to a representation of a curved boundary by using more subdivisions.

Even for non-curved cells the mapping argument can be used for the Eulerian mappings (see class MappingQ1Eulerian) where a mapping is used not only to determine the position of points interior to a cell, but also of the vertices. It offers an opportunity to watch the solution on a deformed triangulation on which the computation was actually carried out, even if the mesh is internally stored in its undeformed configuration and the deformation is only tracked by an additional vector that holds the deformation of each vertex.

Todo:
The mapping argument should be replaced by a hp::MappingCollection in case of a DoFHandler with hp-capabilities.

Definition at line 344 of file data_out_faces.cc.

## ◆ first_face()

template<int dim, int spacedim>
 DataOutFaces< dim, spacedim >::FaceDescriptor DataOutFaces< dim, spacedim >::first_face
virtual

Return the first face which we want output for. The default implementation returns the first face of a (locally owned) active cell or, if the surface_only option was set in the destructor (as is the default), the first such face that is located on the boundary.

If you want to use a different logic to determine which faces should contribute to the creation of graphical output, you can overload this function in a derived class.

Definition at line 428 of file data_out_faces.cc.

## ◆ next_face()

template<int dim, int spacedim>
 DataOutFaces< dim, spacedim >::FaceDescriptor DataOutFaces< dim, spacedim >::next_face ( const FaceDescriptor & face )
virtual

Return the next face after which we want output for. If there are no more faces, dofs->end() is returned as the first component of the return value.

The default implementation returns the next face of a (locally owned) active cell, or the next such on the boundary (depending on whether the surface_only option was provided to the constructor).

This function traverses the mesh active cell by active cell (restricted to locally owned cells), and then through all faces of the cell. As a result, interior faces are output twice, a feature that is useful for discontinuous Galerkin methods or if a DataPostprocessor is used that might produce results that are discontinuous between cells).

This function can be overloaded in a derived class to select a different set of faces. 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 should be done with care.

Definition at line 447 of file data_out_faces.cc.

## ◆ build_one_patch()

template<int dim, int spacedim>
 void DataOutFaces< dim, spacedim >::build_one_patch ( const FaceDescriptor * cell_and_face, internal::DataOutFacesImplementation::ParallelData< dim, spacedim > & data, DataOutBase::Patch< patch_dim, patch_spacedim > & patch )
private

Build one patch. This function is called in a WorkStream context.

Definition at line 97 of file data_out_faces.cc.

## ◆ attach_dof_handler()

 void DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::attach_dof_handler ( const DoFHandler< dim, spacedim > & )
inherited

Designate a dof handler to be used to extract geometry data and the mapping between nodes and node values. This call is not necessary if all added data vectors are supplemented with a DoFHandler argument.

This call is optional: If you add data vectors with specified DoFHandler object, then that contains all information needed to generate the output.

## ◆ attach_triangulation()

 void DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::attach_triangulation ( const Triangulation< dim, spacedim > & )
inherited

Designate a triangulation to be used to extract geometry data and the mapping between nodes and node values.

This call is optional: If you add data vectors with specified DoFHandler object, then that contains all information needed to generate the output. This call is useful when you only output cell vectors and no DoFHandler at all, in which case it provides the geometry.

 void DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::add_data_vector ( const VectorType & data, const std::vector< std::string > & names, const DataVectorType type = type_automatic, const std::vector< DataComponentInterpretation::DataComponentInterpretation > & data_component_interpretation = {} )
inherited

Add a data vector together with its name.

A pointer to the vector is stored, so you have to make sure the vector exists at that address at least as long as you call the write_* functions.

It is assumed that the vector has the same number of components as there are degrees of freedom in the dof handler, in which case it is assumed to be a vector storing nodal data; or the size may be the number of active cells on the present grid, in which case it is assumed to be a cell data vector. As the number of degrees of freedom and of cells is usually not equal, the function can determine itself which type of vector it is given. However, there are corner cases where this automatic determination does not work. One example is if you compute with piecewise constant elements and have a scalar solution, then there are as many cells as there are degrees of freedom (though they may be numbered differently). Another possibility is if you have a 1d mesh embedded in 2d space and the mesh consists of a closed curve of cells; in this case, there are as many nodes as there are cells, and when using a Q1 element you will have as many degrees of freedom as there are cells. In these cases, you can change the last argument of the function from its default value type_automatic to either type_dof_data or type_cell_data, depending on what the vector represents. Apart from such corner cases, you can leave the argument at its default value and let the function determine the type of the vector itself.

If it is a vector holding DoF data, the names given shall be one for each component of the underlying finite element. If it is a finite element composed of only one subelement, then there is another function following which takes a single name instead of a vector of names.

The data_component_interpretation argument contains information about how the individual components of output files that consist of more than one data set are to be interpreted.

For example, if one has a finite element for the Stokes equations in 2d, representing components (u,v,p), one would like to indicate that the first two, u and v, represent a logical vector so that later on when we generate graphical output we can hand them off to a visualization program that will automatically know to render them as a vector field, rather than as two separate and independent scalar fields.

The default value of this argument (i.e. an empty vector) corresponds is equivalent to a vector of values DataComponentInterpretation::component_is_scalar, indicating that all output components are independent scalar fields. However, if the given data vector represents logical vectors, you may pass a vector that contains values DataComponentInterpretation::component_is_part_of_vector. In the example above, one would pass in a vector with components (DataComponentInterpretation::component_is_part_of_vector, DataComponentInterpretation::component_is_part_of_vector, DataComponentInterpretation::component_is_scalar) for (u,v,p).

The names of a data vector shall only contain characters which are letters, underscore and a few other ones. Refer to the ExcInvalidCharacter exception declared in this class to see which characters are valid and which are not.

Note
The actual type for the vector argument may be any vector type from which FEValues can extract values on a cell using the FEValuesBase::get_function_values() function.

Definition at line 731 of file data_out_dof_data.h.

 void DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::add_data_vector ( const VectorType & data, const std::string & name, const DataVectorType type = type_automatic, const std::vector< DataComponentInterpretation::DataComponentInterpretation > & data_component_interpretation = {} )
inherited

This function is an abbreviation to the above one (see there for a discussion of the various arguments), intended for use with finite elements that are not composed of subelements. In this case, only one name per data vector needs to be given, which is what this function takes. It simply relays its arguments after a conversion of the name to a vector of strings, to the other add_data_vector() function above.

If data is a vector with multiple components this function will generate distinct names for all components by appending an underscore and the number of each component to name

The actual type for the template argument may be any vector type from which FEValues can extract values on a cell using the FEValuesBase::get_function_values() function.

Definition at line 756 of file data_out_dof_data.h.

 void DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::add_data_vector ( const DoFHandler< dim, spacedim > & dof_handler, const VectorType & data, const std::vector< std::string > & names, const std::vector< DataComponentInterpretation::DataComponentInterpretation > & data_component_interpretation = {} )
inherited

This function is an extension of the above one (see there for a discussion of the arguments except the first one) and allows to set a vector with its own DoFHandler object. This DoFHandler needs to be compatible with the other DoFHandler objects assigned with calls to add_data_vector or attach_dof_handler, in the sense that all of the DoFHandler objects need to be based on the same triangulation. This function allows you to export data from multiple DoFHandler objects that describe different solution components. An example of using this function is given in step-61.

Since this function takes a DoFHandler object and hence naturally represents dof data, the data vector type argument present in the other methods above is not necessary.

Definition at line 780 of file data_out_dof_data.h.

 void DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::add_data_vector ( const DoFHandler< dim, spacedim > & dof_handler, const VectorType & data, const std::string & name, const std::vector< DataComponentInterpretation::DataComponentInterpretation > & data_component_interpretation = {} )
inherited

This function is an abbreviation of the function above with only a scalar dof_handler given and a single data name.

Definition at line 794 of file data_out_dof_data.h.

 void DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::add_data_vector ( const VectorType & data, const DataPostprocessor< spacedim > & data_postprocessor )
inherited

This function is an alternative to the above ones, allowing the output of derived quantities instead of the given data. This conversion has to be done in a class derived from DataPostprocessor. This function is used in step-29. Other uses are shown in step-32 and step-33.

The names for these derived quantities are provided by the data_postprocessor argument. Likewise, the data_component_interpretation argument of the other add_data_vector() functions is provided by the data_postprocessor argument. As only data of type type_dof_data can be transformed, this type is also known implicitly and does not have to be given.

Note
The actual type for the vector argument may be any vector type from which FEValues can extract values on a cell using the FEValuesBase::get_function_values() function.
The DataPostprocessor object (i.e., in reality the object of your derived class) has to live until the DataOut object is destroyed as the latter keeps a pointer to the former and will complain if the object pointed to is destroyed while the latter still has a pointer to it. If both the data postprocessor and DataOut objects are local variables of a function (as they are, for example, in step-29), then you can avoid this error by declaring the data postprocessor variable before the DataOut variable as objects are destroyed in reverse order of declaration.

Definition at line 829 of file data_out_dof_data.h.

 void DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::add_data_vector ( const DoFHandler< dim, spacedim > & dof_handler, const VectorType & data, const DataPostprocessor< spacedim > & data_postprocessor )
inherited

Same function as above, but with a DoFHandler object that does not need to coincide with the DoFHandler initially set. Note that the postprocessor can only read data from the given DoFHandler and solution vector, not other solution vectors or DoFHandlers.

 void DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::add_mg_data_vector ( const DoFHandler< dim, spacedim > & dof_handler, const MGLevelObject< VectorType > & data, const std::vector< std::string > & names, const std::vector< DataComponentInterpretation::DataComponentInterpretation > & data_component_interpretation = std::vector< DataComponentInterpretation::DataComponentInterpretation>() )
inherited

This function adds the vector-valued multilevel vector data in the form of a vector on each level that belongs to the DoFHandler dof_handler to the graphical output. This function is typically used in conjunction with a call to set_cell_selection() that selects cells on a specific level and not the active cells (the default).

A vector data can be obtained in several ways, for example by using Multigrid::solution or Multigrid::defect during or after a multigrid cycle or by interpolating a solution via MGTransferMatrixFree::interpolate_to_mg().

The handling of names and data_component_interpretation is identical to the add_data_vector() function.

 void DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::add_mg_data_vector ( const DoFHandler< dim, spacedim > & dof_handler, const MGLevelObject< VectorType > & data, const std::string & name )
inherited

Scalar version of the function above.

## ◆ clear_data_vectors()

 void DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::clear_data_vectors ( )
inherited

Release the pointers to the data vectors. This allows output of a new set of vectors without supplying the DoF handler again. Therefore, the DataOut object can be used in an algebraic context. Note that besides the data vectors also the patches already computed are deleted.

## ◆ clear_input_data_references()

 void DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::clear_input_data_references ( )
inherited

Release pointers to all input data elements, i.e. pointers to to the DoF handler object. This function may be useful when you have called the build_patches function of derived class, since then the patches are built and the input data is no more needed, nor is there a need to reference it. You can then output the patches detached from the main thread and need not make sure anymore that the DoF handler object must not be deleted before the output thread is finished.

## ◆ merge_patches()

 void DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::merge_patches ( const DataOut_DoFData< dim2, patch_dim, spacedim2, patch_spacedim > & source, const Point< patch_spacedim > & shift = Point() )
inherited

This function can be used to merge the patches that were created using the build_patches function of the object given as argument into the list of patches created by this object. This is sometimes handy if one has, for example, a domain decomposition algorithm where each block is represented by a DoFHandler of its own, but one wants to output the solution on all the blocks at the same time.

For this to work, the given argument and this object need to have the same number of output vectors, and they need to use the same number of subdivisions per patch. The output will probably look rather funny if patches in both objects overlap in space.

If you call build_patches() for this object after merging in patches, the previous state is overwritten, and the merged-in patches are lost.

The second parameter allows to shift each node of the patches in the object passed in in the first parameter by a certain amount. This is sometimes useful to generate "exploded" views of a collection of blocks.

This function will fail if either this or the other object did not yet set up any patches.

Definition at line 927 of file data_out_dof_data.h.

## ◆ clear()

 virtual void DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::clear ( )
virtualinherited

Release the pointers to the data vectors and the DoF handler. You have to set all data entries again using the add_data_vector() function. The pointer to the dof handler is cleared as well, along with all other data. In effect, this function resets everything to a virgin state.

## ◆ memory_consumption()

 std::size_t DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::memory_consumption ( ) const
inherited

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

## ◆ get_patches()

 virtual const std::vector& DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::get_patches ( ) const
overridevirtualinherited

Function by which the base class's functions get to know what patches they shall write to a file.

Implements DataOutInterface< dim, spacedim >.

## ◆ get_dataset_names()

 virtual std::vector DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::get_dataset_names ( ) const
overrideprotectedvirtualinherited

Virtual function through which the names of data sets are obtained by the output functions of the base class.

Implements DataOutInterface< dim, spacedim >.

## ◆ get_nonscalar_data_ranges()

 virtual std::vector< std::tuple > DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::get_nonscalar_data_ranges ( ) const
overrideprotectedvirtualinherited

Overload of the respective DataOutInterface::get_nonscalar_data_ranges() function. See there for a more extensive documentation.

Reimplemented from DataOutInterface< dim, spacedim >.

## ◆ get_fes()

 std::vector > > DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::get_fes ( ) const
protectedinherited

Extracts the finite elements stored in the dof_data object, including a dummy object of FE_DGQ<dim>(0) in case only the triangulation is used.

 void DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::add_data_vector_internal ( const DoFHandler< dim, spacedim > * dof_handler, const VectorType & data, const std::vector< std::string > & names, const DataVectorType type, const std::vector< DataComponentInterpretation::DataComponentInterpretation > & data_component_interpretation, const bool deduce_output_names )
privateinherited

Common function called by the four public add_data_vector methods.

## ◆ patch_dim

template<int dim, int spacedim = dim>
 constexpr int DataOutFaces< dim, spacedim >::patch_dim = dim - 1
staticconstexpr

Dimension parameters for the patches.

Definition at line 117 of file data_out_faces.h.

## ◆ patch_spacedim

template<int dim, int spacedim = dim>
 constexpr int DataOutFaces< dim, spacedim >::patch_spacedim = spacedim
staticconstexpr

Definition at line 118 of file data_out_faces.h.

## ◆ surface_only

template<int dim, int spacedim = dim>
 const bool DataOutFaces< dim, spacedim >::surface_only
private

Parameter deciding between surface meshes and full wire basket.

Definition at line 234 of file data_out_faces.h.

## ◆ triangulation

 SmartPointer > DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::triangulation
protectedinherited

Pointer to the triangulation object.

Definition at line 956 of file data_out_dof_data.h.

## ◆ dofs

 SmartPointer > DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::dofs
protectedinherited

Pointer to the optional handler object.

Definition at line 961 of file data_out_dof_data.h.

## ◆ dof_data

 std::vector > > DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::dof_data
protectedinherited

List of data elements with vectors of values for each degree of freedom.

Definition at line 968 of file data_out_dof_data.h.

## ◆ cell_data

 std::vector > > DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::cell_data
protectedinherited

List of data elements with vectors of values for each cell.

Definition at line 975 of file data_out_dof_data.h.

## ◆ patches

 std::vector DataOut_DoFData< dim, patch_dim, spacedim, patch_spacedim >::patches
protectedinherited

This is a list of patches that is created each time build_patches() is called. These patches are used in the output routines of the base classes.

Definition at line 982 of file data_out_dof_data.h.

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