Peano 4
Loading...
Searching...
No Matches
Public Member Functions | Data Fields | Protected Attributes
peano4.visualisation.output.Visualiser.Visualiser Class Reference

The visualiser is first and foremost a persistency layer around datasets. More...

Inheritance diagram for peano4.visualisation.output.Visualiser.Visualiser:
Inheritance graph
[legend]
Collaboration diagram for peano4.visualisation.output.Visualiser.Visualiser:
Collaboration graph
[legend]

Public Member Functions

 __init__ (self, file_name, verbose=False)
 file_name: String Name of a Peano patch file.
 
 display (self)
 This is the one routine the visualisers typically do overwrite.
 
 select_dataset (self, number)
 number: int
 
 append_filter (self, filter, reload=True)
 
 remove_filters (self)
 
 reload (self)
 Invokes render_dataset() and then sets the resulting self._data as output of the client side object of the trivial producer.
 

Data Fields

 identifier
 
 verbose
 
 is_data_associated_to_cell
 

Protected Attributes

 _file_name
 
 _dataset_number
 
 _filter
 
 _cell_data
 
 _dof
 
 _dimensions
 
 _unknowns
 
 _description
 
 _is_data_associated_to_cell
 
 _mapping
 
 _timestamp
 
 _dimension
 

Detailed Description

The visualiser is first and foremost a persistency layer around datasets.

It serves as abstract base class for real output formats, i.e. it can parse files and hold them, but it does not do anything with them.

Definition at line 53 of file Visualiser.py.

Constructor & Destructor Documentation

◆ __init__()

peano4.visualisation.output.Visualiser.Visualiser.__init__ ( self,
file_name,
verbose = False )

file_name: String Name of a Peano patch file.

This has to be a meta file, i.e. a file which does not hold actual data but hosts data sets that in turn link to actual data.

:: Attributes

self._data: Patch

Reimplemented in peano4.visualisation.output.VTU.VTU, peano4.visualisation.output.PatchFile.PatchFile, and peano4.visualisation.output.Interactive.Interactive.

Definition at line 63 of file Visualiser.py.

Member Function Documentation

◆ append_filter()

peano4.visualisation.output.Visualiser.Visualiser.append_filter ( self,
filter,
reload = True )

Definition at line 112 of file Visualiser.py.

References peano4.visualisation.output.Visualiser.Visualiser._filter, peano4.visualisation.output.Interactive.Interactive.reload(), peano4.visualisation.output.Visualiser.Visualiser.reload(), and peano4.visualisation.output.VTU.VTU.reload().

Here is the call graph for this function:

◆ display()

peano4.visualisation.output.Visualiser.Visualiser.display ( self)

This is the one routine the visualisers typically do overwrite.

Reimplemented in peano4.visualisation.output.Interactive.Interactive, peano4.visualisation.output.PatchFile.PatchFile, and peano4.visualisation.output.VTU.VTU.

Definition at line 93 of file Visualiser.py.

References TP::Parameters.verbose, peano4.visualisation.Convert.Convert.verbose, peano4.visualisation.filters.Filter.Filter.verbose, and peano4.visualisation.output.Visualiser.Visualiser.verbose.

◆ reload()

peano4.visualisation.output.Visualiser.Visualiser.reload ( self)

Invokes render_dataset() and then sets the resulting self._data as output of the client side object of the trivial producer.

Does not work if self._tp is set to None

Reimplemented in peano4.visualisation.output.Interactive.Interactive, and peano4.visualisation.output.VTU.VTU.

Definition at line 129 of file Visualiser.py.

References peano4.visualisation.output.PatchFile.PatchFile._cell_data, peano4.visualisation.output.Visualiser.Visualiser._cell_data, peano4.visualisation.output.Visualiser.Visualiser._dataset_number, peano4.visualisation.output.Visualiser.Visualiser._description, Scenarios.Acoustic_planar_waves.Acoustic_planar_waves._dimensions, Scenarios.Advection_linear.Advection_linear._dimensions, Scenarios.Elastic_planar_waves.Elastic_planar_waves._dimensions, Scenarios.Euler_gaussian_bell.Euler_gaussian_bell._dimensions, Scenarios.Euler_isotropic_vortex.Euler_isotropic_vortex._dimensions, Scenarios.Scenario.Scenario._dimensions, Scenarios.SWE_radial_dam_break.SWE_radial_dam_break._dimensions, Scenarios.SWE_resting_lake.SWE_resting_lake._dimensions, exahype2.Project.Project._dimensions, petsc.Project.Project._dimensions, peano4.visualisation.output.Interactive.Interactive._dimensions, peano4.visualisation.output.PatchFile.PatchFile._dimensions, peano4.visualisation.output.Visualiser.Visualiser._dimensions, peano4.visualisation.output.VTU.VTU._dimensions, swift2.Project.Project._dimensions, convert::input::PeanoTextPatchFileReader._dimensions, tarch::plotter::griddata::blockstructured::PeanoHDF5PatchFileWriter._dimensions, tarch::plotter::griddata::blockstructured::PeanoTextPatchFileWriter._dimensions, peano4.visualisation.output.PatchFile.PatchFile._dof, peano4.visualisation.output.Visualiser.Visualiser._dof, exahype2.postprocessing.PerformanceData.PerformanceData._file_name, peano4.visualisation.output.Visualiser.Visualiser._file_name, peano4.visualisation.output.Visualiser.Visualiser._filter, peano4.visualisation.output.Visualiser.Visualiser._is_data_associated_to_cell, peano4.visualisation.output.Visualiser.Visualiser._mapping, peano4.visualisation.output.Visualiser.Visualiser._timestamp, peano4.visualisation.output.VTU.VTU._timestamp, exahype2.solvers.aderdg.ADERDG.ADERDG._unknowns, PointWiseClawPackAdaptiveTimeStepSize.PointWiseClawPackAdaptiveTimeStepSize._unknowns, exahype2.solvers.fv.FV.FV._unknowns, exahype2.solvers.rkdg.RungeKuttaDG.RungeKuttaDG._unknowns, exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences._unknowns, petsc.solvers.CollocatedLowOrderDiscretisation.CollocatedLowOrderDiscretisation._unknowns, peano4.visualisation.output.PatchFile.PatchFile._unknowns, peano4.visualisation.output.Visualiser.Visualiser._unknowns, exahype2::CellAccess._unknowns, exahype2::enumerator::AoSLexicographicEnumerator._unknowns, exahype2::enumerator::AoSoALexicographicEnumerator._unknowns, exahype2::enumerator::FaceAoSLexicographicEnumerator._unknowns, exahype2::enumerator::SingleDoFEnumerator._unknowns, exahype2::enumerator::SoALexicographicEnumerator._unknowns, peano4.visualisation.output.Visualiser.Visualiser.identifier, validate, TP::Parameters.verbose, peano4.visualisation.Convert.Convert.verbose, peano4.visualisation.filters.Filter.Filter.verbose, and peano4.visualisation.output.Visualiser.Visualiser.verbose.

Referenced by peano4.visualisation.output.Visualiser.Visualiser.append_filter(), peano4.visualisation.output.Interactive.Interactive.display(), peano4.visualisation.output.Visualiser.Visualiser.remove_filters(), and peano4.visualisation.output.Visualiser.Visualiser.select_dataset().

Here is the caller graph for this function:

◆ remove_filters()

peano4.visualisation.output.Visualiser.Visualiser.remove_filters ( self)

Definition at line 121 of file Visualiser.py.

References peano4.visualisation.output.Visualiser.Visualiser._filter, peano4.visualisation.output.Interactive.Interactive.reload(), peano4.visualisation.output.Visualiser.Visualiser.reload(), and peano4.visualisation.output.VTU.VTU.reload().

Here is the call graph for this function:

◆ select_dataset()

peano4.visualisation.output.Visualiser.Visualiser.select_dataset ( self,
number )

number: int

Definition at line 104 of file Visualiser.py.

References peano4.visualisation.output.Visualiser.Visualiser._dataset_number, peano4.visualisation.output.Interactive.Interactive.reload(), peano4.visualisation.output.Visualiser.Visualiser.reload(), and peano4.visualisation.output.VTU.VTU.reload().

Referenced by peano4.visualisation.output.PatchFile.PatchFile.display(), and peano4.visualisation.output.VTU.VTU.display().

Here is the call graph for this function:
Here is the caller graph for this function:

Field Documentation

◆ _cell_data

peano4.visualisation.output.Visualiser.Visualiser._cell_data
protected

Definition at line 82 of file Visualiser.py.

Referenced by peano4.visualisation.output.Visualiser.Visualiser.reload(), and peano4.visualisation.output.VTU.VTU.reload().

◆ _dataset_number

peano4.visualisation.output.Visualiser.Visualiser._dataset_number
protected

Definition at line 77 of file Visualiser.py.

Referenced by peano4.visualisation.output.Visualiser.Visualiser.reload(), and peano4.visualisation.output.Visualiser.Visualiser.select_dataset().

◆ _description

peano4.visualisation.output.Visualiser.Visualiser._description
protected

Definition at line 87 of file Visualiser.py.

Referenced by peano4.visualisation.output.Visualiser.Visualiser.reload().

◆ _dimension

peano4.visualisation.output.Visualiser.Visualiser._dimension
protected

Definition at line 210 of file Visualiser.py.

◆ _dimensions

peano4.visualisation.output.Visualiser.Visualiser._dimensions
protected

Definition at line 85 of file Visualiser.py.

Referenced by exahype2.Project.Project.__configure_makefile(), petsc.Project.Project.__configure_makefile(), swift2.Project.Project.__configure_makefile(), exahype2.Project.Project.__export_constants(), petsc.Project.Project.__export_constants(), swift2.Project.Project.__export_constants(), Scenarios.Elastic_planar_waves.Elastic_planar_waves.analytical_solution(), exahype2.Project.Project.generate_Peano4_project(), Scenarios.Elastic_planar_waves.Elastic_planar_waves.initial_conditions(), peano4.visualisation.output.Visualiser.Visualiser.reload(), swift2.Project.Project.set_global_simulation_parameters(), petsc.Project.Project.set_global_simulation_parameters(), exahype2.Project.Project.set_global_simulation_parameters(), and Scenarios.Scenario.Scenario.set_global_simulation_parameters().

◆ _dof

peano4.visualisation.output.Visualiser.Visualiser._dof
protected

Definition at line 84 of file Visualiser.py.

Referenced by peano4.visualisation.output.Visualiser.Visualiser.reload().

◆ _file_name

peano4.visualisation.output.Visualiser.Visualiser._file_name
protected

Definition at line 76 of file Visualiser.py.

Referenced by peano4.visualisation.output.VTU.VTU.display(), exahype2.postprocessing.PerformanceData.PerformanceData.parse(), and peano4.visualisation.output.Visualiser.Visualiser.reload().

◆ _filter

peano4.visualisation.output.Visualiser.Visualiser._filter
protected

Definition at line 78 of file Visualiser.py.

Referenced by peano4.visualisation.output.Visualiser.Visualiser.append_filter(), peano4.visualisation.output.Visualiser.Visualiser.reload(), and peano4.visualisation.output.Visualiser.Visualiser.remove_filters().

◆ _is_data_associated_to_cell

peano4.visualisation.output.Visualiser.Visualiser._is_data_associated_to_cell
protected

Definition at line 88 of file Visualiser.py.

Referenced by peano4.visualisation.output.Visualiser.Visualiser.reload().

◆ _mapping

peano4.visualisation.output.Visualiser.Visualiser._mapping
protected

Definition at line 89 of file Visualiser.py.

Referenced by peano4.visualisation.output.Visualiser.Visualiser.reload().

◆ _timestamp

peano4.visualisation.output.Visualiser.Visualiser._timestamp
protected

Definition at line 90 of file Visualiser.py.

Referenced by peano4.visualisation.output.Visualiser.Visualiser.reload().

◆ _unknowns

peano4.visualisation.output.Visualiser.Visualiser._unknowns
protected

Definition at line 86 of file Visualiser.py.

Referenced by exahype2.solvers.fv.FV.FV.__str__(), exahype2.solvers.rkdg.RungeKuttaDG.RungeKuttaDG.__str__(), exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences.__str__(), exahype2.solvers.aderdg.ADERDG.ADERDG._init_dictionary_with_default_parameters(), exahype2.solvers.fv.FV.FV._init_dictionary_with_default_parameters(), exahype2.solvers.rkdg.RungeKuttaDG.RungeKuttaDG._init_dictionary_with_default_parameters(), exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences._init_dictionary_with_default_parameters(), petsc.solvers.CollocatedLowOrderDiscretisation.CollocatedLowOrderDiscretisation.add_to_plot(), exahype2.solvers.aderdg.ADERDG.ADERDG.generate_kernels(), petsc.solvers.CollocatedLowOrderDiscretisation.CollocatedLowOrderDiscretisation.number_of_matrix_entries_per_vertex(), peano4.visualisation.output.Visualiser.Visualiser.reload(), exahype2.solvers.fv.clawpack.GlobalFixedTimeStep.GlobalFixedTimeStep.set_pointwise_constraint(), exahype2.solvers.aderdg.ADERDG.ADERDG.unknowns(), exahype2.solvers.fv.FV.FV.unknowns(), exahype2.solvers.rkdg.RungeKuttaDG.RungeKuttaDG.unknowns(), exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences.unknowns(), exahype2.solvers.fv.FV.FV.unknowns(), exahype2.solvers.rkdg.RungeKuttaDG.RungeKuttaDG.unknowns(), and exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences.unknowns().

◆ identifier

peano4.visualisation.output.Visualiser.Visualiser.identifier

Definition at line 79 of file Visualiser.py.

Referenced by peano4.visualisation.output.Visualiser.Visualiser.reload().

◆ is_data_associated_to_cell

peano4.visualisation.output.Visualiser.Visualiser.is_data_associated_to_cell

Definition at line 219 of file Visualiser.py.

Referenced by peano4.visualisation.PatchFileParser.PatchFileParser._initialise_default_mapping_if_no_mapping_specified(), and peano4.visualisation.PatchFileParser.PatchFileParser.parse_file().

◆ verbose

peano4.visualisation.output.Visualiser.Visualiser.verbose

Definition at line 80 of file Visualiser.py.

Referenced by peano4.visualisation.Convert.Convert.__get_selectors(), peano4.visualisation.filters.Filter.Filter.__str__(), peano4.visualisation.Convert.Convert.convert_to_vtk(), peano4.visualisation.output.Visualiser.Visualiser.display(), peano4.visualisation.Convert.Convert.extract_fine_grid(), peano4.visualisation.Convert.Convert.plot_domain_decomposition(), peano4.visualisation.output.Visualiser.Visualiser.reload(), peano4.visualisation.filters.AverageOverCell.AverageOverCell.render(), peano4.visualisation.filters.Calculator.Calculator.render(), and peano4.visualisation.filters.ExtractFineGrid.ExtractFineGrid.render().

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