Peano
Loading...
Searching...
No Matches
tarch.plotter.api.output.Visualiser.PatchFileData Class Reference

Helper class to capture the important data coming from a patch file. More...

Public Member Functions

 __init__ (self, unknown_name, dimensions)
 
 copy_data_from_parser_object (self, unknown_attributes)
 pass in a UnknownAttributes object from PatchFileParser.py, steal everything and return
 
 apply_renderer_to_data (self, renderer)
 Pass in a renderer object which will modify everything in the way that the filter.render() function intends.
 
 __repr__ (self)
 

Protected Attributes

 _dimensions
 
 _unknown_name
 
 _cell_data
 
 _dof
 
 _unknowns
 
 _is_data_associated_to_cell
 
 _description
 
 _mapping
 

Detailed Description

Helper class to capture the important data coming from a patch file.

This is what we use to capture the combined patch file data from. We could keep everything in the helper class from PatchFileParser, but the intention during the rewrite was to keep everything fairly close to the way the original vis scripts worked.

Definition at line 122 of file Visualiser.py.

Constructor & Destructor Documentation

◆ __init__()

tarch.plotter.api.output.Visualiser.PatchFileData.__init__ (   self,
  unknown_name,
  dimensions 
)

Definition at line 132 of file Visualiser.py.

Member Function Documentation

◆ __repr__()

tarch.plotter.api.output.Visualiser.PatchFileData.__repr__ (   self)

Definition at line 193 of file Visualiser.py.

◆ apply_renderer_to_data()

tarch.plotter.api.output.Visualiser.PatchFileData.apply_renderer_to_data (   self,
  renderer 
)

Pass in a renderer object which will modify everything in the way that the filter.render() function intends.

This is basically the same as render_or_validate_for_each_unknown() from the PatchFileParser class. The reason why we don't need to do it for each unknown here is that the different unknowns have been captured in by the caller of this function

We could rename this to something more general, since i think we modify the same attributes in the same order as the validate function

Definition at line 161 of file Visualiser.py.

References solvers.api.Solver.Solver._cell_data, tarch.plotter.api.output.Visualiser.PatchFileData._cell_data, tarch.plotter.api.output.Visualiser.PatchFileData._description, tarch.plotter.api.output.Visualiser.Visualiser._description, convert::input::PeanoTextPatchFileReader._dimensions, exahype2.api.dslhype.SyntaxTree.Subscript._dimensions, exahype2.api.dslhype.SyntaxTree.Matrix._dimensions, exahype2.api.dslhype.SyntaxTree.TSimpleMemref._dimensions, exahype2.api.dslhype.SyntaxTree.TDataBlock._dimensions, exahype2.api.dslhype.SyntaxTree.MemoryAllocation._dimensions, exahype2.api.dslhype.SyntaxTree.MemoryDeallocation._dimensions, exahype2.api.Project.Project._dimensions, exaparty.api.Project.Project._dimensions, api.Project.Project._dimensions, solvers.api.ContinuousGalerkinDiscretisationGaussLobattoWithBlockJacobi.ContinuousGalerkinDiscretisationGaussLobattoWithBlockJacobi._dimensions, solvers.api.DiscontinuousGalerkinDiscretisationPointWiseRiemannSolver.DiscontinuousGalerkinDiscretisationPointWiseRiemannSolver._dimensions, tarch.plotter.api.output.Visualiser.PatchFileData._dimensions, tarch.plotter.api.output.Visualiser.Visualiser._dimensions, tarch.plotter::griddata::blockstructured::PeanoBinaryPatchFileWriter._dimensions, tarch.plotter::griddata::blockstructured::PeanoHDF5PatchFileWriter._dimensions, tarch.plotter::griddata::blockstructured::PeanoTextPatchFileWriter._dimensions, scenarios.acoustic_planar_waves.AcousticPlanarWaves._dimensions, scenarios.advection_linear.AdvectionLinear._dimensions, scenarios.elastic_planar_waves.ElasticPlanarWaves._dimensions, scenarios.euler_gaussian_bell.EulerGaussianBell._dimensions, scenarios.euler_isotropic_vortex.EulerIsotropicVortex._dimensions, scenarios.scenario.Scenario._dimensions, scenarios.swe_radial_dam_break.SWERadialDamBreak._dimensions, scenarios.swe_resting_lake.SWERestingLake._dimensions, tarch.plotter.api.output.Visualiser.PatchFileData._dof, tarch.plotter.api.output.Visualiser.PatchFileData._is_data_associated_to_cell, tarch.plotter.api.output.Visualiser.Visualiser._is_data_associated_to_cell, tarch.plotter.api.output.Visualiser.PatchFileData._mapping, solvers.aderdg.ADERDG.ADERDG._unknowns, solvers.fv.FV.FV._unknowns, solvers.fv.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._unknowns, solvers.fv.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking._unknowns, solvers.fv.rusanov.GlobalFixedTimeStep.GlobalFixedTimeStep._unknowns, solvers.fv.rusanov.GlobalFixedTimeStepWithEnclaveTasking.GlobalFixedTimeStepWithEnclaveTasking._unknowns, solvers.fv.rusanov.LocalTimeStepWithEnclaveTasking.LocalTimeStepWithEnclaveTasking._unknowns, solvers.fv.rusanov.SubcyclingAdaptiveTimeStepWithEnclaveTasking.SubcyclingAdaptiveTimeStepWithEnclaveTasking._unknowns, solvers.fv.rusanov.SubcyclingFixedTimeStep.SubcyclingFixedTimeStep._unknowns, solvers.fv.rusanov.SubcyclingFixedTimeStepWithEnclaveTasking.SubcyclingFixedTimeStepWithEnclaveTasking._unknowns, solvers.rkdg.RungeKuttaDG.RungeKuttaDG._unknowns, solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._unknowns, solvers.rkdg.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking._unknowns, exahype2.api.Solver.Solver._unknowns, exahype2::CellAccess._unknowns, exahype2::enumerator::AoSLexicographicEnumerator._unknowns, exahype2::enumerator::AoSoALexicographicEnumerator._unknowns, exahype2::enumerator::FaceAoSLexicographicEnumerator._unknowns, exahype2::enumerator::SingleDoFEnumerator._unknowns, exahype2::enumerator::SoALexicographicEnumerator._unknowns, api.solvers.CollocatedLowOrderDiscretisation.CollocatedLowOrderDiscretisation._unknowns, and tarch.plotter.api.output.Visualiser.PatchFileData._unknowns.

◆ copy_data_from_parser_object()

tarch.plotter.api.output.Visualiser.PatchFileData.copy_data_from_parser_object (   self,
  unknown_attributes 
)

pass in a UnknownAttributes object from PatchFileParser.py, steal everything and return

Definition at line 142 of file Visualiser.py.

References solvers.api.Solver.Solver._cell_data, tarch.plotter.api.output.Visualiser.PatchFileData._cell_data, tarch.plotter.api.output.Visualiser.PatchFileData._description, tarch.plotter.api.output.Visualiser.Visualiser._description, tarch.plotter.api.output.Visualiser.PatchFileData._dof, tarch.plotter.api.output.Visualiser.PatchFileData._is_data_associated_to_cell, tarch.plotter.api.output.Visualiser.Visualiser._is_data_associated_to_cell, tarch.plotter.api.output.Visualiser.PatchFileData._mapping, tarch.plotter.api.output.Visualiser.PatchFileData._unknown_name, solvers.aderdg.ADERDG.ADERDG._unknowns, solvers.fv.FV.FV._unknowns, solvers.fv.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._unknowns, solvers.fv.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking._unknowns, solvers.fv.rusanov.GlobalFixedTimeStep.GlobalFixedTimeStep._unknowns, solvers.fv.rusanov.GlobalFixedTimeStepWithEnclaveTasking.GlobalFixedTimeStepWithEnclaveTasking._unknowns, solvers.fv.rusanov.LocalTimeStepWithEnclaveTasking.LocalTimeStepWithEnclaveTasking._unknowns, solvers.fv.rusanov.SubcyclingAdaptiveTimeStepWithEnclaveTasking.SubcyclingAdaptiveTimeStepWithEnclaveTasking._unknowns, solvers.fv.rusanov.SubcyclingFixedTimeStep.SubcyclingFixedTimeStep._unknowns, solvers.fv.rusanov.SubcyclingFixedTimeStepWithEnclaveTasking.SubcyclingFixedTimeStepWithEnclaveTasking._unknowns, solvers.rkdg.RungeKuttaDG.RungeKuttaDG._unknowns, solvers.rkdg.rusanov.GlobalAdaptiveTimeStep.GlobalAdaptiveTimeStep._unknowns, solvers.rkdg.rusanov.GlobalAdaptiveTimeStepWithEnclaveTasking.GlobalAdaptiveTimeStepWithEnclaveTasking._unknowns, exahype2.api.Solver.Solver._unknowns, exahype2::CellAccess._unknowns, exahype2::enumerator::AoSLexicographicEnumerator._unknowns, exahype2::enumerator::AoSoALexicographicEnumerator._unknowns, exahype2::enumerator::FaceAoSLexicographicEnumerator._unknowns, exahype2::enumerator::SingleDoFEnumerator._unknowns, exahype2::enumerator::SoALexicographicEnumerator._unknowns, api.solvers.CollocatedLowOrderDiscretisation.CollocatedLowOrderDiscretisation._unknowns, and tarch.plotter.api.output.Visualiser.PatchFileData._unknowns.

Field Documentation

◆ _cell_data

◆ _description

tarch.plotter.api.output.Visualiser.PatchFileData._description
protected

◆ _dimensions

◆ _dof

tarch.plotter.api.output.Visualiser.PatchFileData._dof
protected

◆ _is_data_associated_to_cell

tarch.plotter.api.output.Visualiser.PatchFileData._is_data_associated_to_cell
protected

◆ _mapping

tarch.plotter.api.output.Visualiser.PatchFileData._mapping
protected

◆ _unknown_name

tarch.plotter.api.output.Visualiser.PatchFileData._unknown_name
protected

◆ _unknowns


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