Peano
Loading...
Searching...
No Matches
peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair Class Reference
Inheritance diagram for peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair:
Inheritance graph
[legend]
Collaboration diagram for peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair:
Collaboration graph
[legend]

Public Member Functions

 __init__ (self, headfile_template, cppfile_template, classname, namespace, subdirectory, dictionary, default_overwrite=True)
 The template files should be fully qualified classname is a string namespace is a (possibly empty) list of strings.
 generate_file (self, overwrite, full_qualified_filename, template_file)
 generate (self, overwrite, directory)

Data Fields

 headerfile_template = headfile_template
 cppfile_template = cppfile_template
 classname = classname
 namespace = namespace
 subdirectory = subdirectory
 default_overwrite = default_overwrite
 d = dictionary

Private Attributes

 __class__

Detailed Description

Definition at line 10 of file TemplatedHeaderImplementationFilePair.py.

Constructor & Destructor Documentation

◆ __init__()

peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair.__init__ ( self,
headfile_template,
cppfile_template,
classname,
namespace,
subdirectory,
dictionary,
default_overwrite = True )

The template files should be fully qualified classname is a string namespace is a (possibly empty) list of strings.

cppfile_template can be None

Definition at line 11 of file TemplatedHeaderImplementationFilePair.py.

Member Function Documentation

◆ generate()

peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair.generate ( self,
overwrite,
directory )

Definition at line 51 of file TemplatedHeaderImplementationFilePair.py.

References peano4.output.ActionSet.ActionSet.classname, peano4.output.Jinja2TemplatedHeaderFile.Jinja2TemplatedHeaderFile.classname, peano4.output.Jinja2TemplatedHeaderImplementationFilePair.Jinja2TemplatedHeaderImplementationFilePair.classname, peano4.output.Observer.Observer.classname, peano4.output.TemplatedHeaderFile.TemplatedHeaderFile.classname, classname, peano4.output.Jinja2TemplatedHeaderImplementationFilePair.Jinja2TemplatedHeaderImplementationFilePair.cppfile_template, cppfile_template, peano4.output.TemplatedHeaderFile.TemplatedHeaderFile.generate_file(), generate_file(), peano4.output.Jinja2TemplatedHeaderFile.Jinja2TemplatedHeaderFile.headerfile_template, peano4.output.Jinja2TemplatedHeaderImplementationFilePair.Jinja2TemplatedHeaderImplementationFilePair.headerfile_template, peano4.output.TemplatedHeaderFile.TemplatedHeaderFile.headerfile_template, headerfile_template, peano4.datamodel.DoF.DoF.subdirectory, peano4.datamodel.Model.Model.subdirectory, peano4.output.ActionSet.ActionSet.subdirectory, peano4.output.InvokeExternalTool.InvokeExternalTool.subdirectory, peano4.output.Jinja2TemplatedHeaderFile.Jinja2TemplatedHeaderFile.subdirectory, peano4.output.Jinja2TemplatedHeaderImplementationFilePair.Jinja2TemplatedHeaderImplementationFilePair.subdirectory, peano4.output.Observer.Observer.subdirectory, peano4.output.TemplatedHeaderFile.TemplatedHeaderFile.subdirectory, and subdirectory.

Referenced by peano4.Project.Project.build().

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

◆ generate_file()

peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair.generate_file ( self,
overwrite,
full_qualified_filename,
template_file )

Definition at line 42 of file TemplatedHeaderImplementationFilePair.py.

References peano4.output.Constants.Constants.default_overwrite, peano4.output.Jinja2TemplatedHeaderFile.Jinja2TemplatedHeaderFile.default_overwrite, peano4.output.Jinja2TemplatedHeaderImplementationFilePair.Jinja2TemplatedHeaderImplementationFilePair.default_overwrite, peano4.output.Makefile.Makefile.default_overwrite, peano4.output.Observer.Observer.default_overwrite, peano4.output.TemplatedHeaderFile.TemplatedHeaderFile.default_overwrite, and default_overwrite.

Referenced by generate().

Here is the caller graph for this function:

Field Documentation

◆ __class__

peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair.__class__
private

Definition at line 45 of file TemplatedHeaderImplementationFilePair.py.

Referenced by exahype2.solvers.aderdg.ADERDG.ADERDG.__str__(), exahype2.solvers.aderdg.LagrangeBasis.LagrangeBasis.__str__(), exahype2.solvers.elliptic.AMRMarker.AMRMarker.__str__(), exahype2.solvers.elliptic.ConstrainedPoissonEquationForMarkerOnCells.ConstrainedPoissonEquationForMarkerOnCells.__str__(), exahype2.solvers.fv.FV.FV.__str__(), exahype2.solvers.LagrangeBasisWithDiagonalMassMatrix.LagrangeBasisWithDiagonalMassMatrix.__str__(), exahype2.solvers.rkdg.RungeKuttaDG.RungeKuttaDG.__str__(), exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences.__str__(), peano4.visualisation.filters.Filter.Filter.__str__(), exahype2.solvers.aderdg.ADERDG.ADERDG.add_implementation_files_to_project(), solvers.api.CollocatedDLinearDiscretisationWithPointJacobi.CollocatedDLinearDiscretisationWithPointJacobi.add_implementation_files_to_project(), solvers.api.CollocatedMG.CollocatedMG.add_implementation_files_to_project(), and solvers.api.ContinuousGalerkinDiscretisationGaussLobattoWithBlockJacobi.ContinuousGalerkinDiscretisationGaussLobattoWithBlockJacobi.add_implementation_files_to_project().

◆ classname

peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair.classname = classname

Definition at line 21 of file TemplatedHeaderImplementationFilePair.py.

Referenced by generate().

◆ cppfile_template

peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair.cppfile_template = cppfile_template

Definition at line 20 of file TemplatedHeaderImplementationFilePair.py.

Referenced by generate().

◆ d

peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair.d = dictionary

Definition at line 26 of file TemplatedHeaderImplementationFilePair.py.

Referenced by exahype2.solvers.fv.actionsets.DynamicAMR.DynamicAMR.__init__(), exahype2.solvers.fv.actionsets.ProjectPatchOntoFaces.ProjectPatchOntoFaces.__init__(), exahype2.solvers.rkfd.actionsets.DynamicAMR.DynamicAMR.__init__(), peano4.toolbox.particles.PlotParticlesInVTKFormat.PlotParticlesInVTKFormat.add_attribute_to_plot(), peano4.runner.DefaultSequence.DefaultSequence.construct_output(), peano4.solversteps.StepsToStepRepository.StepsToStepRepository.construct_output(), peano4.toolbox.particles.api.AbstractUpdateParticleGridAssociation.AbstractUpdateParticleGridAssociation.get_attributes(), peano4.toolbox.particles.api.UpdateParticleGridAssociation_BucketSort.UpdateParticleGridAssociation_BucketSort.get_attributes(), peano4.toolbox.particles.UpdateParticle_MultiLevelInteraction_Sets.UpdateParticle_MultiLevelInteraction_Sets.get_attributes(), peano4.toolbox.particles.UpdateParticle_MultiLevelInteraction_StackOfLists.UpdateParticle_MultiLevelInteraction_StackOfLists.get_attributes(), peano4.toolbox.particles.UpdateParticle_MultiLevelInteraction_StackOfLists_ContiguousParticles.UpdateParticle_MultiLevelInteraction_StackOfLists_ContiguousParticles.get_attributes(), peano4.toolbox.CreateRegularGrid.CreateRegularGrid.get_body_of_getGridControlEvents(), DGCGCoupling.Test4Coupling.get_body_of_operation(), DGCGCoupling.Test5Coupling.get_body_of_operation(), initCollocatedRandom.InitDofsCollocatedRandomRhs.get_body_of_operation(), InitDG.InitDofsDGTest1.get_body_of_operation(), InitDG.InitDofsIntermediatePhaseTest1.get_body_of_operation(), peano4.toolbox.blockstructured.BackupPatchOverlap.BackupPatchOverlap.get_body_of_operation(), peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.get_body_of_operation(), peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.get_body_of_operation(), peano4.toolbox.blockstructured.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.get_body_of_operation(), peano4.toolbox.blockstructured.ProjectPatchOntoFaces.ProjectPatchOntoFaces.get_body_of_operation(), peano4.toolbox.multigrid.cellbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.get_body_of_operation(), peano4.toolbox.multigrid.MatrixFreeJacobi.MatrixFreeJacobi.get_body_of_operation(), peano4.toolbox.multigrid.vertexbased.ScalarJacobiWithRediscretisation.ScalarJacobiWithRediscretisation.get_body_of_operation(), peano4.toolbox.particles.api.UpdateParallelState.UpdateParallelState.get_body_of_operation(), peano4.toolbox.particles.api.UpdateParticleGridAssociation_BucketSort.UpdateParticleGridAssociation_BucketSort.get_body_of_operation(), peano4.toolbox.particles.api.UpdateParticleGridAssociation_LiftDrop.UpdateParticleGridAssociation_LiftDrop.get_body_of_operation(), peano4.toolbox.particles.api.UpdateParticleGridAssociation_Reassign.UpdateParticleGridAssociation_Reassign.get_body_of_operation(), peano4.toolbox.particles.GatherParticlesInMemoryPool.GatherParticlesInMemoryPool.get_body_of_operation(), peano4.toolbox.particles.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.get_body_of_operation(), peano4.toolbox.particles.InsertParticlesByCoordinates.InsertParticlesByCoordinates.get_body_of_operation(), peano4.toolbox.particles.InsertRandomParticlesIntoUnrefinedCells.InsertRandomParticlesIntoUnrefinedCells.get_body_of_operation(), peano4.toolbox.particles.ParticleAMR.ParticleAMR.get_body_of_operation(), peano4.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis.get_body_of_operation(), peano4.toolbox.particles.PlotParticlesInVTKFormat.PlotParticlesInVTKFormat.get_body_of_operation(), peano4.toolbox.particles.UpdateParticle_MultiLevelInteraction_Sets.UpdateParticle_MultiLevelInteraction_Sets.get_body_of_operation(), peano4.toolbox.particles.UpdateParticle_MultiLevelInteraction_StackOfLists.UpdateParticle_MultiLevelInteraction_StackOfLists.get_body_of_operation(), peano4.toolbox.particles.UpdateParticle_MultiLevelInteraction_StackOfLists_ContiguousParticles.UpdateParticle_MultiLevelInteraction_StackOfLists_ContiguousParticles.get_body_of_operation(), peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction.get_body_of_operation(), peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction_ContiguousParticles.UpdateParticle_SingleLevelInteraction_ContiguousParticles.get_body_of_operation(), peano4.toolbox.PlotCellDataInPeanoBlockFormat.PlotCellDataInPeanoBlockFormat.get_body_of_operation(), peano4.toolbox.PlotGridInPeanoBlockFormat.PlotGridInPeanoBlockFormat.get_body_of_operation(), peano4.toolbox.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.get_body_of_operation(), swift2.actionsets.Cleanup.Cleanup.get_body_of_operation(), swift2.actionsets.DynamicMeshRefinementAnalysis.DynamicMeshRefinementAnalysis.get_body_of_operation(), swift2.actionsets.ScatterGlobalMemory.ScatterGlobalMemory.get_body_of_operation(), swift2.actionsets.UpdateParticleMarker.UpdateParticleMarker.get_body_of_operation(), swift2.api.actionsets.SynchroniseVerticesWithPreviousMeshSweep.SynchroniseVerticesWithPreviousMeshSweep.get_body_of_operation(), swift2.api.boundaryconditions.Fixed.Fixed.get_body_of_operation(), swift2.input.InsertParticlesFromHDF5File.InsertParticlesFromHDF5File.get_body_of_operation(), test8.InitDofsTest8.get_body_of_operation(), peano4.toolbox.particles.api.UpdateParallelState.UpdateParallelState.get_body_of_prepareTraversal(), peano4.toolbox.particles.UpdateParticle_MultiLevelInteraction_Sets.UpdateParticle_MultiLevelInteraction_Sets.get_body_of_prepareTraversal(), peano4.toolbox.particles.UpdateParticle_MultiLevelInteraction_StackOfLists.UpdateParticle_MultiLevelInteraction_StackOfLists.get_body_of_prepareTraversal(), peano4.toolbox.particles.UpdateParticle_MultiLevelInteraction_StackOfLists_ContiguousParticles.UpdateParticle_MultiLevelInteraction_StackOfLists_ContiguousParticles.get_body_of_prepareTraversal(), peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction.get_body_of_prepareTraversal(), peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction_ContiguousParticles.UpdateParticle_SingleLevelInteraction_ContiguousParticles.get_body_of_prepareTraversal(), swift2.actionsets.ScatterGlobalMemory.ScatterGlobalMemory.get_body_of_prepareTraversal(), peano4.toolbox.particles.api.AbstractUpdateParticleGridAssociation.AbstractUpdateParticleGridAssociation.get_body_of_unprepareTraversal(), peano4.toolbox.particles.UpdateParticle_MultiLevelInteraction_Sets.UpdateParticle_MultiLevelInteraction_Sets.get_body_of_unprepareTraversal(), peano4.toolbox.particles.UpdateParticle_MultiLevelInteraction_StackOfLists.UpdateParticle_MultiLevelInteraction_StackOfLists.get_body_of_unprepareTraversal(), peano4.toolbox.particles.UpdateParticle_MultiLevelInteraction_StackOfLists_ContiguousParticles.UpdateParticle_MultiLevelInteraction_StackOfLists_ContiguousParticles.get_body_of_unprepareTraversal(), peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction.get_body_of_unprepareTraversal(), peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction_ContiguousParticles.UpdateParticle_SingleLevelInteraction_ContiguousParticles.get_body_of_unprepareTraversal(), peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.get_clear_guard(), peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.get_constructor_body(), peano4.toolbox.blockstructured.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.get_constructor_body(), peano4.toolbox.particles.api.AbstractUpdateParticleGridAssociation.AbstractUpdateParticleGridAssociation.get_constructor_body(), peano4.toolbox.particles.InsertParticlesByCoordinates.InsertParticlesByCoordinates.get_constructor_body(), peano4.toolbox.particles.PlotParticlesInVTKFormat.PlotParticlesInVTKFormat.get_constructor_body(), peano4.toolbox.PlotCellDataInPeanoBlockFormat.PlotCellDataInPeanoBlockFormat.get_constructor_body(), peano4.toolbox.PlotGridInPeanoBlockFormat.PlotGridInPeanoBlockFormat.get_constructor_body(), peano4.toolbox.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.get_constructor_body(), peano4.toolbox.particles.api.UpdateParticleGridAssociation_BucketSort.UpdateParticleGridAssociation_BucketSort.get_destructor_body(), peano4.toolbox.particles.api.AbstractUpdateParticleGridAssociation.AbstractUpdateParticleGridAssociation.get_includes(), peano4.toolbox.particles.api.UpdateParallelState.UpdateParallelState.get_includes(), peano4.toolbox.particles.GatherParticlesInMemoryPool.GatherParticlesInMemoryPool.get_includes(), peano4.toolbox.particles.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.get_includes(), peano4.toolbox.particles.InsertParticlesByCoordinates.InsertParticlesByCoordinates.get_includes(), peano4.toolbox.particles.InsertRandomParticlesIntoUnrefinedCells.InsertRandomParticlesIntoUnrefinedCells.get_includes(), peano4.toolbox.particles.ParticleAMR.ParticleAMR.get_includes(), peano4.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis.get_includes(), peano4.toolbox.particles.PlotParticlesInVTKFormat.PlotParticlesInVTKFormat.get_includes(), peano4.toolbox.particles.UpdateParticle_MultiLevelInteraction_Sets.UpdateParticle_MultiLevelInteraction_Sets.get_includes(), peano4.toolbox.particles.UpdateParticle_MultiLevelInteraction_StackOfLists.UpdateParticle_MultiLevelInteraction_StackOfLists.get_includes(), peano4.toolbox.particles.UpdateParticle_MultiLevelInteraction_StackOfLists_ContiguousParticles.UpdateParticle_MultiLevelInteraction_StackOfLists_ContiguousParticles.get_includes(), peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction.get_includes(), peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction_ContiguousParticles.UpdateParticle_SingleLevelInteraction_ContiguousParticles.get_includes(), swift2.actionsets.Cleanup.Cleanup.get_includes(), swift2.actionsets.DynamicMeshRefinementAnalysis.DynamicMeshRefinementAnalysis.get_includes(), swift2.actionsets.ScatterGlobalMemory.ScatterGlobalMemory.get_includes(), swift2.actionsets.UpdateParticleMarker.UpdateParticleMarker.get_includes(), swift2.api.actionsets.SynchroniseVerticesWithPreviousMeshSweep.SynchroniseVerticesWithPreviousMeshSweep.get_includes(), swift2.api.boundaryconditions.Fixed.Fixed.get_includes(), swift2.input.InsertParticlesFromHDF5File.InsertParticlesFromHDF5File.get_includes(), peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.get_interpolate_guard(), peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.get_restrict_guard(), peano4.toolbox.blockstructured.ProjectPatchOntoFaces.ProjectPatchOntoFaces.guard(), peano4.toolbox.blockstructured.ProjectPatchOntoFaces.ProjectPatchOntoFaces.guard(), peano4.toolbox.blockstructured.BackupPatchOverlap.BackupPatchOverlap.set_guard_predicate(), peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.switch_interpolation_scheme(), and peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.switch_restriction_scheme().

◆ default_overwrite

peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair.default_overwrite = default_overwrite

Definition at line 24 of file TemplatedHeaderImplementationFilePair.py.

Referenced by generate_file().

◆ headerfile_template

peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair.headerfile_template = headfile_template

Definition at line 19 of file TemplatedHeaderImplementationFilePair.py.

Referenced by generate().

◆ namespace

peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair.namespace = namespace

Definition at line 22 of file TemplatedHeaderImplementationFilePair.py.

Referenced by peano4.Project.Project.add_subproject().

◆ subdirectory

peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair.subdirectory = subdirectory

Definition at line 23 of file TemplatedHeaderImplementationFilePair.py.

Referenced by generate().

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