ReadUnstructuredVTK< dim, number > Class Template Reference

#include <read_vtk.h>

Inheritance diagram for ReadUnstructuredVTK< dim, number >:

Collaboration diagram for ReadUnstructuredVTK< dim, number >:

Public Member Functions
	ReadUnstructuredVTK (const InitialConditionFile &_ic_file, const SpatialDiscretization< dim > &_spatial_discretization)
	Constructor.
vtkUnstructuredGrid *	get_output ()
	Get the vtk output.
dealii::types::global_dof_index	get_n_points () const
	Get the number of points.
dealii::types::global_dof_index	get_n_cells () const
	Get the number of cells.
void	print_file () override
	Print the vtk file for debugging.
std::vector< std::string >	get_scalars_names ()
	Get the names of the scalars in the vtk file.
std::vector< std::string >	get_vectors_names ()
	Get the names of the vectors in the vtk file.
number	get_scalar_value (const dealii::Point< dim > &point, const std::string &scalar_name) override
	Get scalar value for a given point.
dealii::Vector< number >	get_vector_value (const dealii::Point< dim > &point, const std::string &vector_name) override
	Get vector value for a given point.
Public Member Functions inherited from ReadFieldBase< dim, number >
	ReadFieldBase (const InitialConditionFile &_ic_file, const SpatialDiscretization< dim > &_spatial_discretization)
	Constructor.
virtual	~ReadFieldBase ()=default
	Destructor.
	ReadFieldBase (const ReadFieldBase &read_base)=delete
	Copy constructor.
ReadFieldBase &	operator= (const ReadFieldBase &read_base)=delete
	Copy assignment.
	ReadFieldBase (ReadFieldBase &&read_base) noexcept=delete
	Move constructor.
ReadFieldBase &	operator= (ReadFieldBase &&read_base) noexcept=delete
	Move assignment.

Private Attributes
vtkNew< vtkUnstructuredGridReader >	reader
	Reader for the vtk file.
dealii::types::global_dof_index	n_points
	Number of points.
dealii::types::global_dof_index	n_cells
	Number of cells.
unsigned int	n_scalars
	Number of scalars in file.
unsigned int	n_vectors
	Number of vectors in file.
const unsigned int	n_points_per_hex_cell = 8
	Number of points in a hex cell.
const unsigned int	n_space_coordinates = 3
	Number of space coordinates in a point.

Additional Inherited Members
Protected Attributes inherited from ReadFieldBase< dim, number >
const SpatialDiscretization< dim > &	spatial_discretization
	Spatial discretization object.
const InitialConditionFile &	ic_file
	Initial condition file object.

Constructor & Destructor Documentation

ReadUnstructuredVTK()

template<unsigned int dim, typename number >

ReadUnstructuredVTK< dim, number >::ReadUnstructuredVTK	(	const InitialConditionFile &	_ic_file,
		const SpatialDiscretization< dim > &	_spatial_discretization
	)

Constructor.

Member Function Documentation

get_n_cells()

template<unsigned int dim, typename number >

dealii::types::global_dof_index ReadUnstructuredVTK< dim, number >::get_n_cells ( ) const

inline

Get the number of cells.

get_n_points()

template<unsigned int dim, typename number >

dealii::types::global_dof_index ReadUnstructuredVTK< dim, number >::get_n_points ( ) const

inline

Get the number of points.

get_output()

template<unsigned int dim, typename number >

vtkUnstructuredGrid * ReadUnstructuredVTK< dim, number >::get_output ( )

inline

Get the vtk output.

get_scalar_value()

template<unsigned int dim, typename number >

number ReadUnstructuredVTK< dim, number >::get_scalar_value ( const dealii::Point< dim > &  point, const std::string &  scalar_name  )

inlineoverridevirtual

Get scalar value for a given point.

Implements ReadFieldBase< dim, number >.

get_scalars_names()

template<unsigned int dim, typename number >

std::vector< std::string > ReadUnstructuredVTK< dim, number >::get_scalars_names ( )

inline

Get the names of the scalars in the vtk file.

get_vector_value()

template<unsigned int dim, typename number >

dealii::Vector< number > ReadUnstructuredVTK< dim, number >::get_vector_value ( const dealii::Point< dim > &  point, const std::string &  vector_name  )

inlineoverridevirtual

Get vector value for a given point.

Implements ReadFieldBase< dim, number >.

get_vectors_names()

template<unsigned int dim, typename number >

std::vector< std::string > ReadUnstructuredVTK< dim, number >::get_vectors_names ( )

inline

Get the names of the vectors in the vtk file.

print_file()

template<unsigned int dim, typename number >

void ReadUnstructuredVTK< dim, number >::print_file ( )

inlineoverridevirtual

Print the vtk file for debugging.

Implements ReadFieldBase< dim, number >.

Member Data Documentation

n_cells

template<unsigned int dim, typename number >

dealii::types::global_dof_index ReadUnstructuredVTK< dim, number >::n_cells

private

Number of cells.

n_points

template<unsigned int dim, typename number >

dealii::types::global_dof_index ReadUnstructuredVTK< dim, number >::n_points

private

Number of points.

n_points_per_hex_cell

template<unsigned int dim, typename number >

const unsigned int ReadUnstructuredVTK< dim, number >::n_points_per_hex_cell = 8

private

Number of points in a hex cell.

n_scalars

template<unsigned int dim, typename number >

unsigned int ReadUnstructuredVTK< dim, number >::n_scalars

private

Number of scalars in file.

n_space_coordinates

template<unsigned int dim, typename number >

const unsigned int ReadUnstructuredVTK< dim, number >::n_space_coordinates = 3

private

Number of space coordinates in a point.

n_vectors

template<unsigned int dim, typename number >

unsigned int ReadUnstructuredVTK< dim, number >::n_vectors

private

Number of vectors in file.

reader

template<unsigned int dim, typename number >

vtkNew<vtkUnstructuredGridReader> ReadUnstructuredVTK< dim, number >::reader

private

Reader for the vtk file.

---

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

• /home/runner/work/phaseField/phaseField/include/prismspf/field_input/read_vtk.h