Peano 4
Loading...
Searching...
No Matches
dastgen2.attributes.Double.Double Class Reference

cardinality is a string (you can thus use symbols as well as long as they will be defined at compile time). More...

Inheritance diagram for dastgen2.attributes.Double.Double:
Collaboration diagram for dastgen2.attributes.Double.Double:

Public Member Functions

 __init__ (self, name, valid_mantissa_bits=None, ifdefs=[], qualifier=Attribute.Qualifier.NONE, initval=None)
 @Pawel Can you add some docu?
 
 get_methods (self, _full_qualified_class_name, for_declaration=True)
 Return sequence of methods that are defined for this attribute.
 
 get_plain_C_attributes (self, for_constructor=False)
 Return list of n-tuples.
 
 get_method_body (self, signature)
 I hand in the method signature (see get_methods()) and wanna get the whole implementation.
 
 get_native_MPI_type (self)
 Return native (built-in) MPI datatype.
 
 get_to_string (self)
 Return string representation of attribute.
 
 valid_mantissa_bits (self)
 
 valid_mantissa_bits (self, value)
 Set mantissa used.
 
- Public Member Functions inherited from dastgen2.attributes.Attribute.Attribute
 get_public_fields (self)
 Return string that is to be embedded into the public part of the class definition.
 
 use_default_copy_constructor (self)
 If this routine returns False, the generator will create a copy constructor copying each attribute over via a setter/getter combination.
 
 get_constructor_arguments (self)
 Return list of tuple of arguments for the constructor.
 
 get_first_plain_C_attribute (self)
 For MPI for example, I need to know the first attribute.
 
 get_attribute_declaration_string (self)
 Construct the string used for variable declaration using the output of get_plain_C_attributes(self).
 
 get_accessor_name (self)
 Generate the accessor name used throughout dastgen2 to create variables, function names, etc.
 
 name (self)
 I expect that there's at least one setter/getter pair.
 
 get_includes (self)
 

Protected Attributes

 _valid_mantissa_bits
 
 _is_constexpr
 
- Protected Attributes inherited from dastgen2.attributes.Attribute.Attribute
 _name
 
 _initval
 

Additional Inherited Members

- Data Fields inherited from dastgen2.attributes.Attribute.Attribute
 use_data_store
 
 ifdefs
 
 qualifier
 
 expose_in_header_file
 
- Protected Member Functions inherited from dastgen2.attributes.Attribute.Attribute
 _is_static (self)
 
 _is_const_static (self)
 
 _is_const (self)
 
 _is_constexpr (self)
 

Detailed Description

cardinality is a string (you can thus use symbols as well as long as they will be defined at compile time).

Pass None if you are working with a scalar.

Definition at line 6 of file Double.py.

Constructor & Destructor Documentation

◆ __init__()

dastgen2.attributes.Double.Double.__init__ ( self,
name,
valid_mantissa_bits = None,
ifdefs = [],
qualifier = Attribute.Qualifier.NONE,
initval = None )

@Pawel Can you add some docu?

Reimplemented from dastgen2.attributes.Attribute.Attribute.

Reimplemented in peano4.dastgen2.Peano4DoubleArray.Peano4DoubleArray, and dastgen2.attributes.DoubleArray.DoubleArray.

Definition at line 15 of file Double.py.

Member Function Documentation

◆ get_method_body()

dastgen2.attributes.Double.Double.get_method_body ( self,
signature )

I hand in the method signature (see get_methods()) and wanna get the whole implementation.

Reimplemented from dastgen2.attributes.Attribute.Attribute.

Reimplemented in dastgen2.attributes.DoubleArray.DoubleArray, and peano4.dastgen2.Peano4DoubleArray.Peano4DoubleArray.

Definition at line 123 of file Double.py.

References limiting.PosterioriLimiting.PosterioriLimiting._name, limiting.StaticLimiting.StaticLimiting._name, dastgen2.attributes.Attribute.Attribute._name, dastgen2.attributes.BooleanArray.BooleanArray._name, dastgen2.attributes.Enumeration.Enumeration._name, exahype2.solvers.aderdg.ADERDG.ADERDG._name, exahype2.solvers.elliptic.AMRMarker.AMRMarker._name, exahype2.solvers.elliptic.ConstrainedPoissonEquationForMarkerOnCells.ConstrainedPoissonEquationForMarkerOnCells._name, exahype2.solvers.fv.EnclaveTasking.EnclaveTasking._name, exahype2.solvers.fv.FV.FV._name, exahype2.solvers.rkdg.RungeKuttaDG.RungeKuttaDG._name, exahype2.solvers.rkdg.SeparateSweeps.SeparateSweeps._name, exahype2.solvers.rkdg.SeparateSweepsWithEnclaveTasking.SeparateSweepsWithEnclaveTasking._name, exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences._name, exahype2.solvers.rkfd.OneSweepPerRungeKuttaStep.OneSweepPerRungeKuttaStep._name, exahype2.solvers.rkfd.SeparateSweeps.SeparateSweeps._name, exahype2.solvers.rkfd.SeparateSweepsWithEnclaveTasking.SeparateSweepsWithEnclaveTasking._name, petsc.solvers.Solver.Solver._name, peano4.dastgen2.Peano4DoubleArray.Peano4DoubleArray._name, peano4.dastgen2.Peano4IntegerArray.Peano4IntegerArray._name, tarch::services::ServiceRepository::ServiceEntry._name, and dastgen2.attributes.Attribute.Attribute.use_data_store.

◆ get_methods()

dastgen2.attributes.Double.Double.get_methods ( self,
_full_qualified_class_name,
for_declaration = True )

Return sequence of methods that are defined for this attribute.

Each entry is a tuple. Its first entry is the signature of the function (not including the semicolon), the second entry is the return type.

for_declaration: Boolean if True, assume we want method names for function declaration, not definition. Some generators might - for example - add additional annotations for the declaration such as Clang attributes. The most frequently used use case for this flag is the static annotation. To make a function a class function, you have to declare it as static. But the definition does not allow you to repeat that static keyword again.

Reimplemented from dastgen2.attributes.Attribute.Attribute.

Reimplemented in dastgen2.attributes.DoubleArray.DoubleArray, and peano4.dastgen2.Peano4DoubleArray.Peano4DoubleArray.

Definition at line 45 of file Double.py.

References dastgen2.attributes.Attribute.Attribute._is_const(), dastgen2.attributes.Attribute.Attribute._is_const_static(), dastgen2.attributes.Attribute.Attribute._is_constexpr(), dastgen2.attributes.Boolean.Boolean._is_constexpr, dastgen2.attributes.Double.Double._is_constexpr, dastgen2.attributes.Integer.Integer._is_constexpr, dastgen2.attributes.String.String._is_constexpr, dastgen2.attributes.Attribute.Attribute._is_static(), and dastgen2.attributes.Attribute.Attribute.get_accessor_name().

Here is the call graph for this function:

◆ get_native_MPI_type()

dastgen2.attributes.Double.Double.get_native_MPI_type ( self)

Return native (built-in) MPI datatype.

Return None if there's no direct mapping. The actual result is not a string only, but a list of tuples from native type to cardinality.

Reimplemented from dastgen2.attributes.Attribute.Attribute.

Reimplemented in dastgen2.attributes.DoubleArray.DoubleArray, and peano4.dastgen2.Peano4DoubleArray.Peano4DoubleArray.

Definition at line 136 of file Double.py.

◆ get_plain_C_attributes()

dastgen2.attributes.Double.Double.get_plain_C_attributes ( self,
for_constructor = False )

Return list of n-tuples.

The tuple can either host two, three or four entries. The list itself may contain arbitrary many tuples, as one attribute logically can map onto multiple technical attributes. For example, when declaring an array, also declare an integer variable containing its length.

for_constructor: bool whether the return value of this function is intended for use in the constructor method of the DataModel. If true, will omit (optionally provided) initialization values in the attribute string.

Two entries

The first triple entry always is the name, the second one the type. Type has to be plain C.

Three entries

The first triple entry always is the name, the second one the type. Type has to be plain C. The third entry is a C++ attribute, i.e. a string embedded into [[...]].

Four entries

The first triple entry always is the name, the second one the type. Type has to be plain C. The third entry is a C++ attribute, i.e. a string embedded into [[...]]. The fourth attribute is a list of ifdef symbols that have to be defined to use this attribute. The list of symbols is concatenated with an and. You can return an empty list. All symbol definitions can also be expressions such sa DEBUG>0 or defined(DEBUG).

Please note that these latter ifdefs are something completely different than the base class ifdefs. The base class ifdefs are to be used if you want to switch attributes on and off. The attributes here are used to switch between realisation variants.

Arrays

Arrays can be modelled by adding a cardinality ("[15]" for example) to the first triple entry, i.e. the name.

Reimplemented from dastgen2.attributes.Attribute.Attribute.

Reimplemented in dastgen2.attributes.DoubleArray.DoubleArray, and peano4.dastgen2.Peano4DoubleArray.Peano4DoubleArray.

Definition at line 84 of file Double.py.

References dastgen2.attributes.Attribute.Attribute._initval, dastgen2.attributes.Attribute.Attribute._is_const(), dastgen2.attributes.Attribute.Attribute._is_const_static(), dastgen2.attributes.Attribute.Attribute._is_constexpr(), dastgen2.attributes.Boolean.Boolean._is_constexpr, dastgen2.attributes.Double.Double._is_constexpr, dastgen2.attributes.Integer.Integer._is_constexpr, dastgen2.attributes.String.String._is_constexpr, dastgen2.attributes.Attribute.Attribute._is_static(), limiting.PosterioriLimiting.PosterioriLimiting._name, limiting.StaticLimiting.StaticLimiting._name, dastgen2.attributes.Attribute.Attribute._name, dastgen2.attributes.BooleanArray.BooleanArray._name, dastgen2.attributes.Enumeration.Enumeration._name, exahype2.solvers.aderdg.ADERDG.ADERDG._name, exahype2.solvers.elliptic.AMRMarker.AMRMarker._name, exahype2.solvers.elliptic.ConstrainedPoissonEquationForMarkerOnCells.ConstrainedPoissonEquationForMarkerOnCells._name, exahype2.solvers.fv.EnclaveTasking.EnclaveTasking._name, exahype2.solvers.fv.FV.FV._name, exahype2.solvers.rkdg.RungeKuttaDG.RungeKuttaDG._name, exahype2.solvers.rkdg.SeparateSweeps.SeparateSweeps._name, exahype2.solvers.rkdg.SeparateSweepsWithEnclaveTasking.SeparateSweepsWithEnclaveTasking._name, exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences._name, exahype2.solvers.rkfd.OneSweepPerRungeKuttaStep.OneSweepPerRungeKuttaStep._name, exahype2.solvers.rkfd.SeparateSweeps.SeparateSweeps._name, exahype2.solvers.rkfd.SeparateSweepsWithEnclaveTasking.SeparateSweepsWithEnclaveTasking._name, petsc.solvers.Solver.Solver._name, peano4.dastgen2.Peano4DoubleArray.Peano4DoubleArray._name, peano4.dastgen2.Peano4IntegerArray.Peano4IntegerArray._name, tarch::services::ServiceRepository::ServiceEntry._name, dastgen2.attributes.Double.Double._valid_mantissa_bits, dastgen2.attributes.DoubleArray.DoubleArray._valid_mantissa_bits, and peano4.dastgen2.Peano4DoubleArray.Peano4DoubleArray._valid_mantissa_bits.

Referenced by dastgen2.attributes.Attribute.Attribute.get_attribute_declaration_string(), dastgen2.attributes.Attribute.Attribute.get_constructor_arguments(), and dastgen2.attributes.Attribute.Attribute.get_first_plain_C_attribute().

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

◆ get_to_string()

dastgen2.attributes.Double.Double.get_to_string ( self)

Return string representation of attribute.

Reimplemented from dastgen2.attributes.Attribute.Attribute.

Reimplemented in dastgen2.attributes.DoubleArray.DoubleArray, and peano4.dastgen2.Peano4DoubleArray.Peano4DoubleArray.

Definition at line 139 of file Double.py.

References limiting.PosterioriLimiting.PosterioriLimiting._name, limiting.StaticLimiting.StaticLimiting._name, dastgen2.attributes.Attribute.Attribute._name, dastgen2.attributes.BooleanArray.BooleanArray._name, dastgen2.attributes.Enumeration.Enumeration._name, exahype2.solvers.aderdg.ADERDG.ADERDG._name, exahype2.solvers.elliptic.AMRMarker.AMRMarker._name, exahype2.solvers.elliptic.ConstrainedPoissonEquationForMarkerOnCells.ConstrainedPoissonEquationForMarkerOnCells._name, exahype2.solvers.fv.EnclaveTasking.EnclaveTasking._name, exahype2.solvers.fv.FV.FV._name, exahype2.solvers.rkdg.RungeKuttaDG.RungeKuttaDG._name, exahype2.solvers.rkdg.SeparateSweeps.SeparateSweeps._name, exahype2.solvers.rkdg.SeparateSweepsWithEnclaveTasking.SeparateSweepsWithEnclaveTasking._name, exahype2.solvers.rkfd.CellCenteredFiniteDifferences.CellCenteredFiniteDifferences._name, exahype2.solvers.rkfd.OneSweepPerRungeKuttaStep.OneSweepPerRungeKuttaStep._name, exahype2.solvers.rkfd.SeparateSweeps.SeparateSweeps._name, exahype2.solvers.rkfd.SeparateSweepsWithEnclaveTasking.SeparateSweepsWithEnclaveTasking._name, petsc.solvers.Solver.Solver._name, peano4.dastgen2.Peano4DoubleArray.Peano4DoubleArray._name, peano4.dastgen2.Peano4IntegerArray.Peano4IntegerArray._name, tarch::services::ServiceRepository::ServiceEntry._name, and dastgen2.attributes.Attribute.Attribute.use_data_store.

◆ valid_mantissa_bits() [1/2]

◆ valid_mantissa_bits() [2/2]

dastgen2.attributes.Double.Double.valid_mantissa_bits ( self,
value )

Field Documentation

◆ _is_constexpr

◆ _valid_mantissa_bits


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