Peano 4
Loading...
Searching...
No Matches
Public Member Functions | Data Fields | Private Member Functions | Private Attributes
peano4.output.ActionSet.ActionSet Class Reference
Inheritance diagram for peano4.output.ActionSet.ActionSet:
Inheritance graph
[legend]
Collaboration diagram for peano4.output.ActionSet.ActionSet:
Collaboration graph
[legend]

Public Member Functions

 __init__ (self, classname, namespace, subdirectory, implementation=None)
 Implementation of an Action Set.
 
 add_operation (self, name, signature)
 signature is a long tuple.
 
 get_cpp_file_name (self)
 
 generate (self, overwrite, directory)
 

Data Fields

 classname
 
 namespace
 
 subdirectory
 
 operations
 
 include_files
 
 typedefs
 
 implementation
 

Private Member Functions

 __generate_includes (self, outputfile)
 
 __get_operation_arguments (self, operation)
 
 __generate_operation (self, outputfile, operation)
 outputfile points to file, operation to an operation object as added by the solver step
 
 __get_full_qualified_class_name (self)
 
 __generate_header (self, overwrite, directory)
 
 __generate_implementation (self, overwrite, directory)
 

Private Attributes

 __class__
 

Detailed Description

Definition at line 13 of file ActionSet.py.

Constructor & Destructor Documentation

◆ __init__()

peano4.output.ActionSet.ActionSet.__init__ ( self,
classname,
namespace,
subdirectory,
implementation = None )

Implementation of an Action Set.

Please consult peano4.solversteps.ActionSet for a description.

implementation Should be of type peano4.solversteps.Mapping or None. If it is None, then the generated stuff will be a sole interface.

Definition at line 14 of file ActionSet.py.

Member Function Documentation

◆ __generate_header()

peano4.output.ActionSet.ActionSet.__generate_header ( self,
overwrite,
directory )
private

Definition at line 86 of file ActionSet.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, peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair.classname, peano4.output.ActionSet.ActionSet.implementation, 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 peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair.subdirectory.

Referenced by peano4.output.ActionSet.ActionSet.generate(), and peano4.output.Observer.Observer.generate().

Here is the caller graph for this function:

◆ __generate_implementation()

peano4.output.ActionSet.ActionSet.__generate_implementation ( self,
overwrite,
directory )
private

Definition at line 166 of file ActionSet.py.

References peano4.output.ActionSet.ActionSet.__class__, peano4.output.Jinja2TemplatedHeaderImplementationFilePair.Jinja2TemplatedHeaderImplementationFilePair.__class__, peano4.output.Observer.Observer.__class__, peano4.output.TemplatedHeaderFile.TemplatedHeaderFile.__class__, peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair.__class__, peano4.output.ActionSet.ActionSet.__get_full_qualified_class_name(), peano4.output.ActionSet.ActionSet.__get_operation_arguments(), 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, peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair.classname, peano4.output.ActionSet.ActionSet.get_cpp_file_name(), peano4.output.Observer.Observer.get_cpp_file_name(), peano4.output.ActionSet.ActionSet.implementation, and peano4.output.ActionSet.ActionSet.operations.

Referenced by peano4.output.ActionSet.ActionSet.generate(), and peano4.output.Observer.Observer.generate().

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

◆ __generate_includes()

peano4.output.ActionSet.ActionSet.__generate_includes ( self,
outputfile )
private

Definition at line 45 of file ActionSet.py.

References peano4.output.ActionSet.ActionSet.include_files.

◆ __generate_operation()

peano4.output.ActionSet.ActionSet.__generate_operation ( self,
outputfile,
operation )
private

outputfile points to file, operation to an operation object as added by the solver step

Definition at line 62 of file ActionSet.py.

References peano4.output.ActionSet.ActionSet.__get_operation_arguments(), and peano4.output.ActionSet.ActionSet.implementation.

Here is the call graph for this function:

◆ __get_full_qualified_class_name()

peano4.output.ActionSet.ActionSet.__get_full_qualified_class_name ( self)
private

Definition at line 78 of file ActionSet.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, peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair.classname, peano4.datamodel.DoF.DoF.namespace, peano4.datamodel.Model.Model.namespace, peano4.output.ActionSet.ActionSet.namespace, peano4.output.Jinja2TemplatedHeaderFile.Jinja2TemplatedHeaderFile.namespace, peano4.output.Jinja2TemplatedHeaderImplementationFilePair.Jinja2TemplatedHeaderImplementationFilePair.namespace, peano4.output.Observer.Observer.namespace, peano4.output.TemplatedHeaderFile.TemplatedHeaderFile.namespace, peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair.namespace, and peano4.Project.Project.namespace.

Referenced by peano4.output.ActionSet.ActionSet.__generate_implementation().

Here is the caller graph for this function:

◆ __get_operation_arguments()

peano4.output.ActionSet.ActionSet.__get_operation_arguments ( self,
operation )
private

Definition at line 48 of file ActionSet.py.

Referenced by peano4.output.ActionSet.ActionSet.__generate_implementation(), and peano4.output.ActionSet.ActionSet.__generate_operation().

Here is the caller graph for this function:

◆ add_operation()

peano4.output.ActionSet.ActionSet.add_operation ( self,
name,
signature )

signature is a long tuple.

The first entry is the name of the routine, the second entry is the result type. From thereon, one entry gives the name of an attribute, the second one the type.

Definition at line 37 of file ActionSet.py.

References peano4.output.ActionSet.ActionSet.operations.

◆ generate()

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

Definition at line 218 of file ActionSet.py.

References peano4.output.ActionSet.ActionSet.__generate_header(), peano4.output.Observer.Observer.__generate_header(), peano4.output.ActionSet.ActionSet.__generate_implementation(), peano4.output.Observer.Observer.__generate_implementation(), 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 peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair.subdirectory.

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

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

◆ get_cpp_file_name()

peano4.output.ActionSet.ActionSet.get_cpp_file_name ( self)

Definition at line 163 of file ActionSet.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, peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair.classname, 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 peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair.subdirectory.

Referenced by peano4.output.ActionSet.ActionSet.__generate_implementation(), and peano4.output.Observer.Observer.generate().

Here is the caller graph for this function:

Field Documentation

◆ __class__

peano4.output.ActionSet.ActionSet.__class__
private

Definition at line 97 of file ActionSet.py.

Referenced by peano4.output.ActionSet.ActionSet.__generate_implementation(), 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__(), petsc.solvers.CollocatedLowOrderDiscretisation.CollocatedLowOrderDiscretisation.add_implementation_files_to_project(), petsc.solvers.DiscontinuousGalerkinDiscretisation.DiscontinuousGalerkinDiscretisation.add_implementation_files_to_project(), petsc.solvers.HybridDiscontinuousGalerkinDiscretisation.HybridDiscontinuousGalerkinDiscretisation.add_implementation_files_to_project(), petsc.solvers.MixedDiscontinuousGalerkinDiscretisation.MixedDiscontinuousGalerkinDiscretisation.add_implementation_files_to_project(), DiscontinuousGalerkinDiscretisation.DiscontinuousGalerkinDiscretisation.add_implementation_files_to_project(), and exahype2.solvers.aderdg.ADERDG.ADERDG.add_implementation_files_to_project().

◆ classname

peano4.output.ActionSet.ActionSet.classname

Definition at line 26 of file ActionSet.py.

Referenced by peano4.output.ActionSet.ActionSet.__generate_header(), peano4.output.Observer.Observer.__generate_header(), peano4.output.ActionSet.ActionSet.__generate_implementation(), peano4.output.ActionSet.ActionSet.__get_full_qualified_class_name(), peano4.output.Jinja2TemplatedHeaderFile.Jinja2TemplatedHeaderFile.generate(), peano4.output.Jinja2TemplatedHeaderImplementationFilePair.Jinja2TemplatedHeaderImplementationFilePair.generate(), peano4.output.TemplatedHeaderFile.TemplatedHeaderFile.generate(), peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair.generate(), peano4.output.ActionSet.ActionSet.get_cpp_file_name(), and peano4.output.Observer.Observer.get_cpp_file_name().

◆ implementation

peano4.output.ActionSet.ActionSet.implementation

Definition at line 35 of file ActionSet.py.

Referenced by peano4.output.ActionSet.ActionSet.__generate_header(), peano4.output.ActionSet.ActionSet.__generate_implementation(), and peano4.output.ActionSet.ActionSet.__generate_operation().

◆ include_files

peano4.output.ActionSet.ActionSet.include_files

Definition at line 33 of file ActionSet.py.

Referenced by peano4.output.ActionSet.ActionSet.__generate_includes().

◆ namespace

peano4.output.ActionSet.ActionSet.namespace

Definition at line 27 of file ActionSet.py.

Referenced by peano4.output.Observer.Observer.__generate_header(), peano4.output.ActionSet.ActionSet.__get_full_qualified_class_name(), peano4.datamodel.Model.Model.add_cell(), peano4.datamodel.Model.Model.add_face(), peano4.datamodel.Model.Model.add_global_object(), peano4.datamodel.Model.Model.add_vertex(), peano4.datamodel.DoF.DoF.configure(), and peano4.datamodel.DoF.DoF.get_full_qualified_type().

◆ operations

peano4.output.ActionSet.ActionSet.operations

Definition at line 29 of file ActionSet.py.

Referenced by peano4.output.ActionSet.ActionSet.__generate_implementation(), and peano4.output.ActionSet.ActionSet.add_operation().

◆ subdirectory

peano4.output.ActionSet.ActionSet.subdirectory

Definition at line 28 of file ActionSet.py.

Referenced by peano4.output.ActionSet.ActionSet.__generate_header(), peano4.output.Observer.Observer.__generate_header(), peano4.output.ActionSet.ActionSet.generate(), peano4.output.InvokeExternalTool.InvokeExternalTool.generate(), peano4.output.Jinja2TemplatedHeaderFile.Jinja2TemplatedHeaderFile.generate(), peano4.output.Jinja2TemplatedHeaderImplementationFilePair.Jinja2TemplatedHeaderImplementationFilePair.generate(), peano4.output.Observer.Observer.generate(), peano4.output.TemplatedHeaderFile.TemplatedHeaderFile.generate(), peano4.output.TemplatedHeaderImplementationFilePair.TemplatedHeaderImplementationFilePair.generate(), peano4.output.ActionSet.ActionSet.get_cpp_file_name(), and peano4.output.Observer.Observer.get_cpp_file_name().

◆ typedefs

peano4.output.ActionSet.ActionSet.typedefs

Definition at line 34 of file ActionSet.py.

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