Inheritance diagram for aspect::Postprocess::internal::ParticleOutput< dim >:

Public Member Functions
void	build_patches (const Particles::ParticleHandler< dim > &particle_handler, const aspect::Particle::Property::ParticlePropertyInformation &property_information, const std::vector< std::string > &exclude_output_properties, const bool only_group_3d_vectors)

Public Member Functions inherited from DataOutInterface< 0, dim >
	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_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

void	write_deal_II_intermediate_in_parallel (const std::string &filename, const MPI_Comm comm, const DataOutBase::CompressionLevel compression) 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_cf_parallel (const DataOutBase::DataOutFilter &data_filter, const std::string &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)

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

Private Member Functions
const std::vector< DataOutBase::Patch< 0, dim > > &	get_patches () const override

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

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

Private Attributes
std::vector< DataOutBase::Patch< 0, dim > >	patches

std::vector< std::string >	dataset_names

std::vector< std::tuple< unsigned int, unsigned int, std::string, DataComponentInterpretation::DataComponentInterpretation > >	vector_datasets

Additional Inherited Members
Static Public Member Functions inherited from DataOutInterface< 0, dim >
static void	declare_parameters (ParameterHandler &prm)

Protected Member Functions inherited from DataOutInterface< 0, dim >
void	validate_dataset_names () const

Protected Attributes inherited from DataOutInterface< 0, dim >
unsigned int	default_subdivisions

Detailed Description

template<int dim>
class aspect::Postprocess::internal::ParticleOutput< dim >

This class is responsible for writing the particle data into a format that can be written by deal.II, in particular a list of 'patches' that contain one particle per patch. The base class DataOutInterface is templated with a dimension of zero (the dimension of the particle / point), and a space dimension of dim (the dimension in which this zero-dimensional particle lives).

Definition at line 50 of file particles.h.

Member Function Documentation

◆ build_patches()

template<int dim>

void aspect::Postprocess::internal::ParticleOutput< dim >::build_patches	(	const Particles::ParticleHandler< dim > &	particle_handler,
		const aspect::Particle::Property::ParticlePropertyInformation &	property_information,
		const std::vector< std::string > &	exclude_output_properties,
		const bool	only_group_3d_vectors
	)

This function prepares the data for writing. It reads the data from particle_handler and their property information from property_information, and builds a list of patches that is stored internally until the destructor is called. This function needs to be called before one of the write function of the base class can be called to write the output data.

◆ get_patches()

template<int dim>

const std::vector<DataOutBase::Patch<0,dim> >& aspect::Postprocess::internal::ParticleOutput< dim >::get_patches ( ) const

overrideprivatevirtual

Implementation of the corresponding function of the base class.

Implements DataOutInterface< 0, dim >.

◆ get_dataset_names()

template<int dim>

std::vector<std::string> aspect::Postprocess::internal::ParticleOutput< dim >::get_dataset_names ( ) const

overrideprivatevirtual

Implementation of the corresponding function of the base class.

Implements DataOutInterface< 0, dim >.

◆ get_nonscalar_data_ranges()

template<int dim>

std::vector< std::tuple<unsigned int, unsigned int, std::string, DataComponentInterpretation::DataComponentInterpretation> > aspect::Postprocess::internal::ParticleOutput< dim >::get_nonscalar_data_ranges ( ) const

overrideprivatevirtual

Implementation of the corresponding function of the base class.

Reimplemented from DataOutInterface< 0, dim >.

Member Data Documentation

◆ patches

template<int dim>

std::vector<DataOutBase::Patch<0,dim> > aspect::Postprocess::internal::ParticleOutput< dim >::patches

private

Output information that is filled by build_patches() and written by the write function of the base class.

Definition at line 91 of file particles.h.

◆ dataset_names

template<int dim>

std::vector<std::string> aspect::Postprocess::internal::ParticleOutput< dim >::dataset_names

private

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

Definition at line 96 of file particles.h.

◆ vector_datasets

template<int dim>

std::vector< std::tuple<unsigned int, unsigned int, std::string, DataComponentInterpretation::DataComponentInterpretation> > aspect::Postprocess::internal::ParticleOutput< dim >::vector_datasets

private

Store which of the data fields are vectors.

Definition at line 106 of file particles.h.

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

/home/docs/checkouts/readthedocs.org/user_builds/aspect-documentation/checkouts/latest/include/aspect/postprocess/particles.h

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<int dim> class aspect::Postprocess::internal::ParticleOutput< dim >

Member Function Documentation

◆ build_patches()

◆ get_patches()

◆ get_dataset_names()

◆ get_nonscalar_data_ranges()

Member Data Documentation

◆ patches

◆ dataset_names

◆ vector_datasets

template<int dim>
class aspect::Postprocess::internal::ParticleOutput< dim >