Peano
Loading...
Searching...
No Matches
peano4.output.Jinja2TemplatedHeaderFile.Jinja2TemplatedHeaderFile Class Reference
Inheritance diagram for peano4.output.Jinja2TemplatedHeaderFile.Jinja2TemplatedHeaderFile:
Collaboration diagram for peano4.output.Jinja2TemplatedHeaderFile.Jinja2TemplatedHeaderFile:

Public Member Functions

 __init__ (self, headerfile_template, classname, namespace, subdirectory, dictionary, default_overwrite=True, apply_iteratively=False)
 The template files should be fully qualified.
 generate (self, overwrite, directory)

Data Fields

 headerfile_template = headerfile_template
 classname = classname
 namespace = namespace
 subdirectory = subdirectory
 default_overwrite = default_overwrite
 apply_iteratively = apply_iteratively
 d = deepcopy(dictionary)

Private Member Functions

 __generate_file (self, overwrite, full_qualified_filename, template_file)
 template_file: string Usually, this is an absolute file name.

Detailed Description

Definition at line 13 of file Jinja2TemplatedHeaderFile.py.

Constructor & Destructor Documentation

◆ __init__()

peano4.output.Jinja2TemplatedHeaderFile.Jinja2TemplatedHeaderFile.__init__ ( self,
headerfile_template,
classname,
namespace,
subdirectory,
dictionary,
default_overwrite = True,
apply_iteratively = False )

The template files should be fully qualified.

classname is a string namespace is a (possibly empty) list of strings dictionary a series of mappings (cmp. Jinja2 convention)

Definition at line 14 of file Jinja2TemplatedHeaderFile.py.

Member Function Documentation

◆ __generate_file()

peano4.output.Jinja2TemplatedHeaderFile.Jinja2TemplatedHeaderFile.__generate_file ( self,
overwrite,
full_qualified_filename,
template_file )
private

template_file: string Usually, this is an absolute file name.

Definition at line 37 of file Jinja2TemplatedHeaderFile.py.

References apply_iteratively, api.actionsets.EnumerateDoFs.EnumerateDoFs.d, api.actionsets.ImposeDirichletBoundaryConditions.ImposeDirichletBoundaryConditions.d, api.actionsets.ImposeDirichletBoundaryConditionsWithInteriorPenaltyMethod.ImposeDirichletBoundaryConditionsWithInteriorPenaltyMethod.d, api.actionsets.InitCellDoFs.InitCellDoFs.d, api.actionsets.InitFaceDoFs.InitFaceDoFs.d, api.actionsets.InitPetsc.SendDofsToVertices.d, api.actionsets.InitVertexDoFs.InitVertexDoFs.d, api.actionsets.PlotDGDataInPeanoBlockFormat.PlotDGDataInPeanoBlockFormat.d, api.actionsets.PlotExactSolution.PlotExactSolution.d, api.actionsets.ProjectPETScSolutionBackOntoMesh.ProjectPETScSolutionOnCellsBackOntoMesh.d, api.actionsets.ProjectPETScSolutionBackOntoMesh.ProjectPETScSolutionOnVerticesBackOntoMesh.d, api.solvers.CollocatedLowOrderDiscretisation.AssemblePetscMatrix.d, api.solvers.DiscontinuousGalerkinDiscretisation.AssemblePetscMatrix.d, archive_AssemblePETSCMatrix.AssemblePETSCMatrixOnCellsAndFaces.d, exahype2.solvers.aderdg.kernels.AMRRoutines.AMRRoutines.d, exahype2.solvers.aderdg.kernels.CellData.CellData.d, exahype2.solvers.aderdg.kernels.DGMatrices.DGMatrices.d, exahype2.solvers.aderdg.kernels.FusedSpaceTimePredictorVolumeIntegral.FusedSpaceTimePredictorVolumeIntegral.d, exahype2.solvers.aderdg.kernels.Quadrature.Quadrature.d, exahype2.solvers.fv.actionsets.HandleBoundary.HandleBoundary.d, exahype2.solvers.fv.actionsets.RollOverUpdatedFace.RollOverUpdatedFace.d, exahype2.solvers.limiting.kernels.Limiter.Limiter.d, exahype2.solvers.limiting.kernels.Quadrature.Quadrature.d, exahype2.solvers.rkfd.actionsets.HandleBoundary.HandleBoundary.d, exahype2.solvers.rkfd.actionsets.RollOverUpdatedFace.RollOverUpdatedFace.d, exahype2.tracer.DumpTracerIntoDatabase.DumpTracerIntoDatabase.d, exahype2.tracer.InsertParticlesFromFile.InsertParticlesFromFile.d, peano4.datamodel.ModelToDataRepository.ModelToDataRepository.d, peano4.output.Constants.Constants.d, d, ProjectResidualsAndDiagonalOntoFacets.ProjectResidualsAndDiagonalOntoFacets.d, solvers.api.actionsets.CollocatedMGSingleThreaded.UpdateSolution.UpdateSolution.d, solvers.api.actionsets.CollocatedMGSolver.InitDofs.InitDofsCollocatedMG.d, solvers.api.actionsets.CollocatedMGSolver.Prolongation.Prolongation.d, solvers.api.actionsets.CollocatedMGSolver.ResetAndUpdateResidual.ResetAndUpdateResidual.d, solvers.api.actionsets.CollocatedMGSolver.Restriction.Restriction.d, solvers.api.actionsets.CollocatedMGSolver.UpdateSolution.UpdateSolution.d, solvers.api.actionsets.CollocatedSolver.InitDofs.InitDofsCollocated.d, solvers.api.actionsets.CollocatedSolver.ResetAndUpdateResidual.ResetAndUpdateResidual.d, solvers.api.actionsets.CollocatedSolver.UpdateSolution.UpdateSolution.d, solvers.api.actionsets.DGCGCoupling.AbstractDGCGCoupling.d, solvers.api.actionsets.DGCGCoupling.AdditiveDGCGCoupling.d, solvers.api.actionsets.DGCGCoupling.MultiplicativeDGCGCoupling.d, solvers.api.actionsets.DGSolver.ProjectIntoCellAndUpdateCellSolution.ProjectIntoCellAndUpdateCellSolution.d, solvers.api.actionsets.DGSolver.ProjectIntoCellAndUpdateCellSolutionWithTasks.ProjectIntoCellAndUpdateCellSolutionWithTasks.d, solvers.api.actionsets.DGSolver.ProjectOntoFaces.ProjectOntoFaces.d, solvers.api.actionsets.DGSolver.UpdateFaceSolution.UpdateFaceSolution.d, solvers.api.actionsets.DGSolver.UpdateResidual.UpdateResidual.d, solvers.api.actionsets.DGSolver.UpdateResidualWithTasks.UpdateResidualWithTasks.d, solvers.api.actionsets.InitHigherOrderDofs.InitHigherOrderDofs.d, solvers.api.actionsets.PlotDGDataInPeanoBlockFormat.PlotDGDataInPeanoBlockFormat.d, solvers.api.actionsets.PlotDGPatchesInPeanoBlockFormat.PlotDGPatchesInPeanoBlockFormat.d, solvers.api.actionsets.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.d, UpdateCell.UpdateCell.d, UpdateFacets.UpdateFacets.d, peano4.output.Constants.Constants.default_overwrite, and default_overwrite.

Referenced by generate(), and peano4.output.Jinja2TemplatedHeaderImplementationFilePair.Jinja2TemplatedHeaderImplementationFilePair.generate().

Here is the caller graph for this function:

◆ generate()

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

Field Documentation

◆ apply_iteratively

peano4.output.Jinja2TemplatedHeaderFile.Jinja2TemplatedHeaderFile.apply_iteratively = apply_iteratively

Definition at line 27 of file Jinja2TemplatedHeaderFile.py.

Referenced by __generate_file().

◆ classname

◆ d

peano4.output.Jinja2TemplatedHeaderFile.Jinja2TemplatedHeaderFile.d = deepcopy(dictionary)

Definition at line 29 of file Jinja2TemplatedHeaderFile.py.

Referenced by peano4.output.Observer.Observer.__format_template_per_action(), peano4.output.Observer.Observer.__generate_beginTraversal(), peano4.output.Observer.Observer.__generate_clone(), peano4.output.Observer.Observer.__generate_constructor(), peano4.output.Observer.Observer.__generate_endTraversal(), peano4.output.Observer.Observer.__generate_enterCell(), peano4.output.Observer.Observer.__generate_exchange_routines(), __generate_file(), peano4.output.Observer.Observer.__generate_getGridControlEvents(), peano4.output.Observer.Observer.__generate_loadCell(), peano4.output.Observer.Observer.__generate_prepareTraversal(), peano4.output.Observer.Observer.__generate_storeCell(), peano4.output.Observer.Observer.__generate_unprepareTraversal(), 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.output.Makefile.Makefile.add_CXX_flag(), peano4.output.Makefile.Makefile.add_Fortran_flag(), peano4.output.Makefile.Makefile.add_Fortran_module(), peano4.output.Makefile.Makefile.add_header_search_path(), peano4.output.Makefile.Makefile.add_library(), peano4.output.Makefile.Makefile.add_linker_flag(), peano4.runner.DefaultSequence.DefaultSequence.construct_output(), peano4.solversteps.StepsToStepRepository.StepsToStepRepository.construct_output(), peano4.output.Makefile.Makefile.executable_name(), peano4.output.Makefile.Makefile.generate(), peano4.output.Observer.Observer.generateDictEntry(), 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.output.Makefile.Makefile.get_configure_path(), 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.output.Observer.Observer.mkSubDict(), peano4.output.Makefile.Makefile.parse_configure_script_outcome(), peano4.output.Makefile.Makefile.readme_entry(), peano4.output.Makefile.Makefile.readme_package_descriptor(), peano4.output.Makefile.Makefile.set_CXX_compiler(), peano4.output.Makefile.Makefile.set_CXX_flags(), peano4.output.Makefile.Makefile.set_dimension(), peano4.output.Makefile.Makefile.set_executable_name(), peano4.output.Makefile.Makefile.set_Fortran_compiler(), peano4.output.Makefile.Makefile.set_Fortran_flags(), peano4.toolbox.blockstructured.BackupPatchOverlap.BackupPatchOverlap.set_guard_predicate(), peano4.output.Makefile.Makefile.set_linker_flags(), peano4.output.Makefile.Makefile.set_mode(), peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.switch_interpolation_scheme(), and peano4.toolbox.blockstructured.DynamicAMR.DynamicAMR.switch_restriction_scheme().

◆ default_overwrite

◆ headerfile_template

◆ namespace

peano4.output.Jinja2TemplatedHeaderFile.Jinja2TemplatedHeaderFile.namespace = namespace

◆ subdirectory


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