![]() |
Reference documentation for deal.II version 9.4.0
|
#include <deal.II/numerics/data_out_resample.h>
Public Types | |
| enum | DataVectorType |
| using | cell_iterator = typename Triangulation< dim, spacedim >::cell_iterator |
Public Member Functions | |
| DataOutResample (const Triangulation< patch_dim, spacedim > &patch_tria, const Mapping< patch_dim, spacedim > &patch_mapping) | |
| void | update_mapping (const Mapping< dim, spacedim > &mapping, const unsigned int n_subdivisions=0) |
| void | build_patches (const Mapping< dim, spacedim > &mapping, const unsigned int n_subdivisions=0, const typename DataOut< patch_dim, spacedim >::CurvedCellRegion curved_region=DataOut< patch_dim, spacedim >::CurvedCellRegion::curved_boundary) |
| void | build_patches (const typename DataOut< patch_dim, spacedim >::CurvedCellRegion curved_region=DataOut< patch_dim, spacedim >::CurvedCellRegion::curved_boundary) |
| 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 >()) |
| void | merge_patches (const DataOut_DoFData< DoFHandlerType2::dimension, patch_dim, DoFHandlerType2::space_dimension, patch_spacedim > &source, const Point< patch_spacedim > &shift=Point< patch_spacedim >()) |
| virtual void | clear () |
| std::size_t | memory_consumption () const |
| 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) |
Protected Types | |
| using | Patch = ::DataOutBase::Patch< patch_dim, patch_spacedim > |
Protected Member Functions | |
| virtual const std::vector< typename DataOutBase::Patch< patch_dim, spacedim > > & | get_patches () const override |
| 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< Patch > | patches |
| unsigned int | default_subdivisions |
Private Member Functions | |
| 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) |
Private Attributes | |
| DoFHandler< patch_dim, spacedim > | patch_dof_handler |
| const SmartPointer< const Mapping< patch_dim, spacedim > > | patch_mapping |
| DataOut< patch_dim, spacedim > | patch_data_out |
| Utilities::MPI::RemotePointEvaluation< dim, spacedim > | rpe |
| std::shared_ptr< Utilities::MPI::Partitioner > | partitioner |
| std::vector< types::global_dof_index > | point_to_local_vector_indices |
| SmartPointer< const Mapping< dim, spacedim > > | mapping |
| DataOutBase::OutputFormat | default_fmt |
| DataOutBase::DXFlags | dx_flags |
| DataOutBase::UcdFlags | ucd_flags |
| DataOutBase::GnuplotFlags | gnuplot_flags |
| DataOutBase::PovrayFlags | povray_flags |
| DataOutBase::EpsFlags | eps_flags |
| DataOutBase::GmvFlags | gmv_flags |
| DataOutBase::TecplotFlags | tecplot_flags |
| DataOutBase::VtkFlags | vtk_flags |
| DataOutBase::SvgFlags | svg_flags |
| DataOutBase::Deal_II_IntermediateFlags | deal_II_intermediate_flags |
A DataOut-like class that does not output a numerical solution on the cells of the original triangulation but interpolates the result onto a second triangulation (that can be completely unrelated). By using this class, one can output the result obtained on an unstructured mesh onto a structured one or one can create a slice in 3D.
The following code snippet shows the steps how to use the class when the solution is given for a three dimensional triangulation and the result should be outputted on a (2D) slice:
Definition at line 59 of file data_out_resample.h.
|
inherited |
Typedef to the iterator type of the dof handler class under consideration.
Definition at line 604 of file data_out_dof_data.h.
|
protectedinherited |
Abbreviate the somewhat lengthy name for the Patch class.
Definition at line 963 of file data_out_dof_data.h.
|
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.
| DataOutResample< dim, patch_dim, spacedim >::DataOutResample | ( | const Triangulation< patch_dim, spacedim > & | patch_tria, |
| const Mapping< patch_dim, spacedim > & | patch_mapping | ||
| ) |
Constructor taking the triangulation and mapping for which the patches should be generated.
Definition at line 34 of file data_out_resample.cc.
| void DataOutResample< dim, patch_dim, spacedim >::update_mapping | ( | const Mapping< dim, spacedim > & | mapping, |
| const unsigned int | n_subdivisions = 0 |
||
| ) |
Update the mapping of original triangulation. One needs to call this function if the mapping has changed. Just like in the DataOut context, n_subdivisions determines how many "patches" this function will build out of every cell.
This function involves an expensive setup: evaluation points are generated and their owners are determined, which is used to set up the communication pattern.
Definition at line 45 of file data_out_resample.cc.
| void DataOutResample< dim, patch_dim, spacedim >::build_patches | ( | const Mapping< dim, spacedim > & | mapping, |
| const unsigned int | n_subdivisions = 0, |
||
| const typename DataOut< patch_dim, spacedim >::CurvedCellRegion | curved_region = DataOut<patch_dim, spacedim>::CurvedCellRegion::curved_boundary |
||
| ) |
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 cell of a triangulation and DoFHandler object that can then be used to write files in some format that is readable by visualization programs.
Since this function calls internally at the beginning update_mapping(), this function also involves an expensive setup.
Just like in the DataOut::build_patches() context, n_subdivisions determines how many "patches" this function will build out of every cell.
Definition at line 109 of file data_out_resample.cc.
| void DataOutResample< dim, patch_dim, spacedim >::build_patches | ( | const typename DataOut< patch_dim, spacedim >::CurvedCellRegion | curved_region = DataOut<patch_dim, spacedim>::CurvedCellRegion::curved_boundary | ) |
Just like the above function, this function builds a list of patches to be written by the low-level functions of the base class. However it skips the update of the mapping and reuses the one registered via update_mapping(). This allows to skip the expensive setup of the internal communication routines.
Definition at line 122 of file data_out_resample.cc.
|
overrideprotectedvirtual |
Function by which the base class's functions get to know what patches they shall write to a file.
Reimplemented from DataOut_DoFData< dim, patch_dim, spacedim, spacedim >.
Definition at line 191 of file data_out_resample.cc.
|
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.
|
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.
|
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.
Definition at line 731 of file data_out_dof_data.h.
|
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.
|
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.
|
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.
|
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.
Definition at line 829 of file data_out_dof_data.h.
|
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.
|
inherited |
Add a multilevel data vector.
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.
|
inherited |
Scalar version of the function above.
|
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.
|
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.
|
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.
|
inherited |
Definition at line 937 of file data_out_dof_data.h.
|
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.
|
inherited |
Determine an estimate for the memory consumption (in bytes) of this object.
|
overrideprotectedvirtualinherited |
Virtual function through which the names of data sets are obtained by the output functions of the base class.
Implements DataOutInterface< dim, spacedim >.
|
overrideprotectedvirtualinherited |
Overload of the respective DataOutInterface::get_nonscalar_data_ranges() function. See there for a more extensive documentation.
Reimplemented from DataOutInterface< dim, spacedim >.
|
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.
|
privateinherited |
Common function called by the four public add_data_vector methods.
|
private |
Intermediate DoFHandler
Definition at line 133 of file data_out_resample.h.
|
private |
Mapping used in connection with patch_tria.
Definition at line 138 of file data_out_resample.h.
|
private |
DataOut object that does the actual building of the patches.
Definition at line 143 of file data_out_resample.h.
|
private |
Object to evaluate
Definition at line 148 of file data_out_resample.h.
|
private |
Partitioner to create internally distributed vectors.
Definition at line 153 of file data_out_resample.h.
|
private |
Process local indices to access efficiently internal distributed vectors.
Definition at line 158 of file data_out_resample.h.
|
private |
Mapping of the original triangulation provided in update_mapping().
Definition at line 163 of file data_out_resample.h.
|
protectedinherited |
Pointer to the triangulation object.
Definition at line 968 of file data_out_dof_data.h.
|
protectedinherited |
Pointer to the optional handler object.
Definition at line 973 of file data_out_dof_data.h.
|
protectedinherited |
List of data elements with vectors of values for each degree of freedom.
Definition at line 980 of file data_out_dof_data.h.
|
protectedinherited |
List of data elements with vectors of values for each cell.
Definition at line 987 of file data_out_dof_data.h.
|
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 994 of file data_out_dof_data.h.