tarch.plotter.api.input.PatchFileParser.UnknownAttributes Class Reference

Helper class to capture all of the attributes we need for each unknown, but were originally fixed to the PatchFileParser class itself. More...

Public Member Functions
	__init__ (self, unknown_name, dimensions, is_data_associated_to_cell)
	set_unknowns (self, unknowns)
	set_dof (self, dof)
	set_description (self, description)
	unknown_names (self)
	set_celldata (self, celldata)
	set_mapping (self, mapping)
	append_patch (self, patch)
	__repr__ (self)

Data Fields
	unknown_name
	unknowns
	dof
	description
	cell_data
	mapping
	is_data_associated_to_cell
	dimensions

Protected Member Functions
	_initialise_default_mapping_if_no_mapping_specified (self)

Detailed Description

Helper class to capture all of the attributes we need for each unknown, but were originally fixed to the PatchFileParser class itself.

For instance, at time of writing the vis scripts cannot handle displaying separate vtu files for different data that is produced in Peano patch files. An excerpt:

begin patch offset 9.629630e-01 9.629630e-01 size 3.703704e-02 3.703704e-02 begin vertex-values "value" 0 0 0 0 end vertex-values begin vertex-values "rhs" 0 0 0 0 end vertex-values end patch

Previously, the only thing that would get parsed is the "value" field, before moving on. We aim to get it to do the "rhs" part as well.

However, we cannot assume that the number of dofs per axis or unknowns per patch volume will be the same for both. So we create this helper class to hold those.

We fix is_data_associated_to_cell to be the same as the PatchFileParser object which, in turn, means they must be the same for all of the unknowns

Attributes:

file_path: String String of input file path (including filename and extension)

cell_data: list of patches List of Patches with file data

dimensions: Integer Dimension of domains

dof: Integer Number of degrees of freedom per axis

unknowns: Integer Number of unknowns per patch volume

mapping: series of d-dimensional tuples Distorts the domain

set_identifier: String Can be empty to parse everything.

Definition at line 40 of file PatchFileParser.py.

Constructor & Destructor Documentation

__init__()

tarch.plotter.api.input.PatchFileParser.UnknownAttributes.__init__	(		self,
			unknown_name,
			dimensions,
			is_data_associated_to_cell
	)

Definition at line 99 of file PatchFileParser.py.

Member Function Documentation

__repr__()

tarch.plotter.api.input.PatchFileParser.UnknownAttributes.__repr__

(

self

)

Definition at line 157 of file PatchFileParser.py.

_initialise_default_mapping_if_no_mapping_specified()

tarch.plotter.api.input.PatchFileParser.UnknownAttributes._initialise_default_mapping_if_no_mapping_specified (   self )

protected

Definition at line 136 of file PatchFileParser.py.

References convert::data::PatchData.dimensions, convert::data::Variable.dimensions, mghype.api.matrixgenerators.DLinear.DLinear.dimensions, mghype.api.matrixgenerators.DLinearMassIdentity.DLinearMassIdentity.dimensions, mghype.api.matrixgenerators.GaussLobatto.GaussLobatto.dimensions, mghype.api.matrixgenerators.GaussLobatto.GaussLobattoMatrixFree.dimensions, mghype.api.matrixgenerators.MatrixGenerator.MatrixGenerator.dimensions, api.solvers.DiscontinuousGalerkinDiscretisation.DiscontinuousGalerkinDiscretisation.dimensions, tarch.plotter.api.input.PatchFileParser.UnknownAttributes.dimensions, tarch.plotter.api.input.PatchFileParser.PatchFileParser.dimensions, tarch::reader::PeanoTextPatchFileReader::Header.dimensions, equations.acoustic.Acoustic.dimensions, equations.advection.Advection.dimensions, equations.elastic.Elastic.dimensions, equations.equation.Equation.dimensions, equations.euler.Euler.dimensions, equations.swe.SWE_W_Bathymetry.dimensions, equations.swe.SWE_WO_Bathymetry.dimensions, tarch.plotter.api.input.PatchFileParser.UnknownAttributes.dof, tarch.plotter.api.input.PatchFileParser.UnknownAttributes.is_data_associated_to_cell, tarch.plotter.api.input.PatchFileParser.PatchFileParser.is_data_associated_to_cell, and tarch.plotter.api.input.PatchFileParser.UnknownAttributes.mapping.

append_patch()

tarch.plotter.api.input.PatchFileParser.UnknownAttributes.append_patch	(		self,
			patch
	)

Definition at line 154 of file PatchFileParser.py.

References peano4.api.datamodel.Model.Model.cell_data, peano4.api.solversteps.Step.Step.cell_data, and tarch.plotter.api.input.PatchFileParser.UnknownAttributes.cell_data.

set_celldata()

tarch.plotter.api.input.PatchFileParser.UnknownAttributes.set_celldata	(		self,
			celldata
	)

Definition at line 128 of file PatchFileParser.py.

References peano4.api.datamodel.Model.Model.cell_data, peano4.api.solversteps.Step.Step.cell_data, and tarch.plotter.api.input.PatchFileParser.UnknownAttributes.cell_data.

set_description()

tarch.plotter.api.input.PatchFileParser.UnknownAttributes.set_description	(		self,
			description
	)

Definition at line 121 of file PatchFileParser.py.

References package.Exahype2.description, and tarch.plotter.api.input.PatchFileParser.UnknownAttributes.description.

set_dof()

tarch.plotter.api.input.PatchFileParser.UnknownAttributes.set_dof	(		self,
			dof
	)

Definition at line 117 of file PatchFileParser.py.

References tarch.plotter.api.input.PatchFileParser.UnknownAttributes.dof.

set_mapping()

tarch.plotter.api.input.PatchFileParser.UnknownAttributes.set_mapping	(		self,
			mapping
	)

Definition at line 132 of file PatchFileParser.py.

References tarch.plotter.api.input.PatchFileParser.UnknownAttributes.mapping.

set_unknowns()

tarch.plotter.api.input.PatchFileParser.UnknownAttributes.set_unknowns	(		self,
			unknowns
	)

Definition at line 113 of file PatchFileParser.py.

References solvers.aderdg.ADERDG.ADERDG.unknowns(), solvers.fv.FV.FV.unknowns(), solvers.rkdg.RungeKuttaDG.RungeKuttaDG.unknowns(), exahype2.api.Solver.Solver.unknowns(), solvers.fv.FV.FV.unknowns(), solvers.rkdg.RungeKuttaDG.RungeKuttaDG.unknowns(), convert::data::Variable.unknowns, tarch.plotter.api.input.Patch.Patch.unknowns, tarch.plotter.api.input.PatchFileParser.UnknownAttributes.unknowns, and api.ProjectPatchWithHaloOntoFaces.ProjectPatchWithHaloOntoFaces.unknowns.

Here is the call graph for this function:

unknown_names()

tarch.plotter.api.input.PatchFileParser.UnknownAttributes.unknown_names

(

self

)

See also

unknown_names_from_description()

Definition at line 124 of file PatchFileParser.py.

References package.Exahype2.description, tarch.plotter.api.input.PatchFileParser.UnknownAttributes.description, solvers.aderdg.ADERDG.ADERDG.unknowns(), solvers.fv.FV.FV.unknowns(), solvers.rkdg.RungeKuttaDG.RungeKuttaDG.unknowns(), solvers.rkdg.RungeKuttaDG.RungeKuttaDG.unknowns(), convert::data::Variable.unknowns, exahype2.api.Solver.Solver.unknowns(), solvers.fv.FV.FV.unknowns(), tarch.plotter.api.input.Patch.Patch.unknowns, tarch.plotter.api.input.PatchFileParser.UnknownAttributes.unknowns, and api.ProjectPatchWithHaloOntoFaces.ProjectPatchWithHaloOntoFaces.unknowns.

Here is the call graph for this function:

Field Documentation

cell_data

tarch.plotter.api.input.PatchFileParser.UnknownAttributes.cell_data

Definition at line 108 of file PatchFileParser.py.

Referenced by peano4.api.datamodel.Model.Model.__str__(), peano4.api.datamodel.Model.Model.add_cell(), tarch.plotter.api.input.PatchFileParser.UnknownAttributes.append_patch(), peano4.api.datamodel.Model.Model.clear(), peano4.api.datamodel.Model.Model.construct_output(), peano4.api.solversteps.Step.Step.get_cell_operations_signature(), peano4.api.solversteps.Step.Step.get_face_operations_signature(), peano4.api.solversteps.Step.Step.get_touch_cell_signature(), peano4.api.solversteps.Step.Step.get_vertex_operations_signature(), tarch.plotter.api.input.PatchFileParser.UnknownAttributes.set_celldata(), peano4.api.taskgraph.Task.Task.use_cell(), and peano4.api.solversteps.Step.Step.use_cell().

description

tarch.plotter.api.input.PatchFileParser.UnknownAttributes.description

Definition at line 107 of file PatchFileParser.py.

Referenced by tarch.plotter.api.input.PatchFileParser.UnknownAttributes.set_description(), and tarch.plotter.api.input.PatchFileParser.UnknownAttributes.unknown_names().

dimensions

tarch.plotter.api.input.PatchFileParser.UnknownAttributes.dimensions

Definition at line 111 of file PatchFileParser.py.

Referenced by tarch.plotter.api.input.PatchFileParser.PatchFileParser.__parse_meta_data_region(), tarch.plotter.api.input.PatchFileParser.PatchFileParser.__parse_patch_region(), tarch.plotter.api.input.PatchFileParser.PatchFileParser.__record_doubles_per_patch(), tarch.plotter.api.input.PatchFileParser.UnknownAttributes._initialise_default_mapping_if_no_mapping_specified(), mghype.api.matrixgenerators.MatrixGenerator.MatrixGenerator.convert_index_to_dim(), equations.euler.Euler.eigenvalues(), mghype.api.matrixgenerators.MatrixGenerator.MatrixGenerator.eval_integral(), equations.elastic.Elastic.flux(), equations.euler.Euler.flux(), mghype.api.matrixgenerators.GaussLobatto.GaussLobattoMatrixFree.get_boundary_matrix(), mghype.api.matrixgenerators.GaussLobatto.GaussLobattoMatrixFree.get_cell_from_face_matrix(), mghype.api.matrixgenerators.DLinear.DLinear.get_cell_identity_matrix(), mghype.api.matrixgenerators.DLinearMassIdentity.DLinearMassIdentity.get_cell_identity_matrix(), mghype.api.matrixgenerators.DLinear.DLinear.get_cell_mass_matrix(), mghype.api.matrixgenerators.DLinear.DLinear.get_cell_system_matrix_for_laplacian(), mghype.api.matrixgenerators.DLinearMassIdentity.DLinearMassIdentity.get_cell_system_matrix_for_laplacian(), mghype.api.matrixgenerators.MatrixGenerator.MatrixGenerator.get_deriv(), mghype.api.matrixgenerators.MatrixGenerator.MatrixGenerator.get_points_for_dimension(), mghype.api.matrixgenerators.MatrixGenerator.MatrixGenerator.get_polynomial(), mghype.api.matrixgenerators.GaussLobatto.GaussLobattoMatrixFree.get_projection_matrices(), mghype.api.matrixgenerators.MatrixGenerator.MatrixGenerator.get_weights_for_dimension(), matrices.DgGenerator.getCellToFaceMatrix(), api.solvers.DiscontinuousGalerkinDiscretisation.DiscontinuousGalerkinDiscretisation.nodes_per_cell(), api.solvers.DiscontinuousGalerkinDiscretisation.DiscontinuousGalerkinDiscretisation.nodes_per_face(), and tarch.plotter.api.input.PatchFileParser.PatchFileParser.parse_file().

dof

tarch.plotter.api.input.PatchFileParser.UnknownAttributes.dof

Definition at line 106 of file PatchFileParser.py.

Referenced by tarch.plotter.api.input.PatchFileParser.UnknownAttributes._initialise_default_mapping_if_no_mapping_specified(), and tarch.plotter.api.input.PatchFileParser.UnknownAttributes.set_dof().

is_data_associated_to_cell

tarch.plotter.api.input.PatchFileParser.UnknownAttributes.is_data_associated_to_cell

Definition at line 110 of file PatchFileParser.py.

Referenced by tarch.plotter.api.input.PatchFileParser.PatchFileParser.__parse_meta_data_region(), tarch.plotter.api.input.PatchFileParser.PatchFileParser.__parse_patch_region(), tarch.plotter.api.input.PatchFileParser.UnknownAttributes._initialise_default_mapping_if_no_mapping_specified(), and tarch.plotter.api.input.PatchFileParser.PatchFileParser.parse_file().

mapping

tarch.plotter.api.input.PatchFileParser.UnknownAttributes.mapping

Definition at line 109 of file PatchFileParser.py.

Referenced by tarch.plotter.api.input.PatchFileParser.UnknownAttributes._initialise_default_mapping_if_no_mapping_specified(), and tarch.plotter.api.input.PatchFileParser.UnknownAttributes.set_mapping().

unknown_name

tarch.plotter.api.input.PatchFileParser.UnknownAttributes.unknown_name

Definition at line 101 of file PatchFileParser.py.

Referenced by tarch.plotter.api.input.Patch.Patch.__repr__().

unknowns

tarch.plotter.api.input.PatchFileParser.UnknownAttributes.unknowns

Definition at line 104 of file PatchFileParser.py.

Referenced by tarch.plotter.api.input.PatchFileParser.UnknownAttributes.set_unknowns(), and tarch.plotter.api.input.PatchFileParser.UnknownAttributes.unknown_names().

---

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

• src/tarch/plotter/api/input/PatchFileParser.py