![]() |
Peano
|
Wrapper around C++ string which is not a dataype supported by MPI natively. More...
Public Member Functions | |
__init__ (self, name, max_length=80, ifdefs=[], qualifier=Attribute.Qualifier.NONE, initval=None) | |
name: String This is a plain string which has to follow the C++ naming conventions, i.e. | |
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_setter_getter_name (self) | |
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. | |
![]() | |
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 | |
_max_length | |
_is_constexpr | |
![]() | |
_name | |
_initval | |
Additional Inherited Members | |
![]() | |
use_data_store | |
ifdefs | |
qualifier | |
expose_in_header_file | |
![]() | |
_is_static (self) | |
_is_const_static (self) | |
_is_const (self) | |
_is_constexpr (self) | |
Wrapper around C++ string which is not a dataype supported by MPI natively.
max_length Maximum length of the strings that can be handled. The shorter you keep this value, the smaller the MPI message size, as we don't use dynamic data structures. We always map the C++ string onto an array with max_length entries.
dastgen2.attributes.String.String.__init__ | ( | self, | |
name, | |||
ifdefs = 80, | |||
qualifier = [], | |||
initval = Attribute.Qualifier.NONE, | |||
expose_in_header_file = None ) |
name: String This is a plain string which has to follow the C++ naming conventions, i.e.
it is case-sensitive and may not contain any special characters besides the underscore. If also has to be unique within the enclosing data model. However, this uniqueness is a C++ constraint. A DaStGen model can hold the same attribute multiple times, as long as their ifdefs are different and hence mask them out, i.e. ensure that only version is "active" at any compile run.
ifdefs: [String] A set of strings which have to hold at compile time to determine if this attribute does exist or not.
qualifier: self.Qualifier An additional qualifier.
initval: str or None Initial value. The type depends on underlying type. But you can always pass in a string that evaluates to the correct type.
expose_in_header_file: Boolean Flag that determines if an attribute's setters and getters should have an implementation within the header or if the generated C++ code should strictly separate declaration and definition and stick the latter into a separate implementation and hence object file.
Reimplemented from dastgen2.attributes.Attribute.Attribute.
dastgen2.attributes.String.String.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.
Definition at line 168 of file String.py.
References SBH.Limiter._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.limiting.PosterioriLimiting.PosterioriLimiting._name, exahype2.solvers.limiting.StaticLimiting.StaticLimiting._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, peano4.dastgen2.Peano4DoubleArray.Peano4DoubleArray._name, peano4.dastgen2.Peano4IntegerArray.Peano4IntegerArray._name, solvers.api.Solver.Solver._name, mghype::matrixfree::solvers::Solver._name, api.solvers.Solver.Solver._name, and tarch::services::ServiceRepository::ServiceEntry._name.
dastgen2.attributes.String.String.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.
Definition at line 57 of file String.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().
dastgen2.attributes.String.String.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.
Definition at line 201 of file String.py.
References dastgen2.attributes.String.String._max_length.
dastgen2.attributes.String.String.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.
The first triple entry always is the name, the second one the type. Type has to be plain C.
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 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 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.
Definition at line 99 of file String.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(), dastgen2.attributes.String.String._max_length, SBH.Limiter._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.limiting.PosterioriLimiting.PosterioriLimiting._name, exahype2.solvers.limiting.StaticLimiting.StaticLimiting._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, peano4.dastgen2.Peano4DoubleArray.Peano4DoubleArray._name, peano4.dastgen2.Peano4IntegerArray.Peano4IntegerArray._name, solvers.api.Solver.Solver._name, mghype::matrixfree::solvers::Solver._name, api.solvers.Solver.Solver._name, and tarch::services::ServiceRepository::ServiceEntry._name.
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().
dastgen2.attributes.String.String.get_setter_getter_name | ( | self | ) |
Definition at line 165 of file String.py.
References SBH.Limiter._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.limiting.PosterioriLimiting.PosterioriLimiting._name, exahype2.solvers.limiting.StaticLimiting.StaticLimiting._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, peano4.dastgen2.Peano4DoubleArray.Peano4DoubleArray._name, peano4.dastgen2.Peano4IntegerArray.Peano4IntegerArray._name, solvers.api.Solver.Solver._name, mghype::matrixfree::solvers::Solver._name, api.solvers.Solver.Solver._name, and tarch::services::ServiceRepository::ServiceEntry._name.
dastgen2.attributes.String.String.get_to_string | ( | self | ) |
Return string representation of attribute.
Reimplemented from dastgen2.attributes.Attribute.Attribute.
Definition at line 204 of file String.py.
References dastgen2.attributes.Attribute.Attribute.get_accessor_name().
|
protected |
Definition at line 92 of file String.py.
Referenced by dastgen2.attributes.Boolean.Boolean.get_methods(), dastgen2.attributes.Double.Double.get_methods(), dastgen2.attributes.Integer.Integer.get_methods(), dastgen2.attributes.String.String.get_methods(), dastgen2.attributes.UserDefinedType.UserDefinedType.get_methods(), dastgen2.attributes.Boolean.Boolean.get_plain_C_attributes(), dastgen2.attributes.Double.Double.get_plain_C_attributes(), dastgen2.attributes.Integer.Integer.get_plain_C_attributes(), dastgen2.attributes.String.String.get_plain_C_attributes(), and dastgen2.attributes.UserDefinedType.UserDefinedType.get_plain_C_attributes().
|
protected |
Definition at line 53 of file String.py.
Referenced by dastgen2.attributes.String.String.get_native_MPI_type(), and dastgen2.attributes.String.String.get_plain_C_attributes().