Particles::DataOut< dim, spacedim > Class Template Reference

#include <deal.II/particles/data_out.h>

Inheritance diagram for Particles::DataOut< dim, spacedim >:

Public Member Functions
	DataOut ()=default
	~DataOut ()=default
void	build_patches (const Particles::ParticleHandler< dim, spacedim > &particles)
Public Member Functions inherited from DataOutInterface< 0, spacedim >
	DataOutInterface ()
virtual	~DataOutInterface ()=default
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_tecplot_binary (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, 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, 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, MPI_Comm comm) const
void	write_xdmf_file (const std::vector< XDMFEntry > &entries, const std::string &filename, MPI_Comm comm) const
void	write_hdf5_parallel (const DataOutBase::DataOutFilter &data_filter, const std::string &filename, 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, 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)
void	set_flags (const FlagType &flags)
std::string	default_suffix (const DataOutBase::OutputFormat output_format=DataOutBase::default_format) const
void	parse_parameters (ParameterHandler &prm)
std::size_t	memory_consumption () const

Protected Member Functions
virtual const std::vector< DataOutBase::Patch< 0, spacedim > > &	get_patches () const override
virtual std::vector< std::string >	get_dataset_names () const override
Protected Member Functions inherited from DataOutInterface< 0, spacedim >
virtual const std::vector< DataOutBase::Patch< dim, spacedim > > &	get_patches () const=0
virtual std::vector< std::string >	get_dataset_names () const=0
virtual std::vector< std::tuple< unsigned int, unsigned int, std::string, DataComponentInterpretation::DataComponentInterpretation > >	get_nonscalar_data_ranges () const
void	validate_dataset_names () const

Private Attributes
std::vector< DataOutBase::Patch< 0, spacedim > >	patches
std::vector< std::string >	dataset_names

Additional Inherited Members
Static Public Member Functions inherited from DataOutInterface< 0, spacedim >
static void	declare_parameters (ParameterHandler &prm)
Protected Attributes inherited from DataOutInterface< 0, spacedim >
unsigned int	default_subdivisions

Detailed Description

template<int dim, int spacedim>
class Particles::DataOut< dim, spacedim >

This class generates graphical output for the particles stored by a ParticleHandler object. From a particle handler, it generates patches which can then be used to write traditional output files. This class currently only supports witing the particle position and their ID and does not allow to write the properties attached to the particles

Author

Bruno Blais, Luca Heltai 2019

Definition at line 44 of file data_out.h.

Constructor & Destructor Documentation

DataOut()

template<int dim, int spacedim>

Particles::DataOut< dim, spacedim >::DataOut ( )

default

Default constructor for the Particles::DataOut class.

~DataOut()

template<int dim, int spacedim>

Particles::DataOut< dim, spacedim >::~DataOut ( )

default

Destructor for the Particles::DataOut class.

Member Function Documentation

build_patches()

template<int dim, int spacedim>

void DataOut< dim, spacedim >::build_patches

(

const Particles::ParticleHandler< dim, spacedim > &

particles

)

Build the patches for a given particle handler.

Parameters

[in]

particles

A particle handler for which the patches will be built. A dim=0 patch is built for each particle. The position of the particle is used to build the node position and the ID of the particle is added as a single data element.

Author

Bruno Blais, Luca Heltai 2019

Definition at line 25 of file data_out.cc.

get_patches()

template<int dim, int spacedim>

const std::vector< DataOutBase::Patch< 0, spacedim > > & DataOut< dim, spacedim >::get_patches

overrideprotectedvirtual

Returns the patches built by the data_out class which was previously built using a particle handler

Definition at line 48 of file data_out.cc.

get_dataset_names()

template<int dim, int spacedim>

std::vector< std::string > DataOut< dim, spacedim >::get_dataset_names

overrideprotectedvirtual

Virtual function through which the names of data sets are obtained from this class

Definition at line 57 of file data_out.cc.

Member Data Documentation

patches

template<int dim, int spacedim>

std::vector<DataOutBase::Patch<0, spacedim> > Particles::DataOut< dim, spacedim >::patches

private

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 92 of file data_out.h.

dataset_names

template<int dim, int spacedim>

std::vector<std::string> Particles::DataOut< dim, spacedim >::dataset_names

private

A list of field names for all data components stored in patches.

Definition at line 97 of file data_out.h.

---

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

• include/deal.II/particles/data_out.h
• source/particles/data_out.cc