GeneratorProfile: added the external array string.

cellml · Aug 16, 2024 · a46dbca · a46dbca
1 parent b1b7536
commit a46dbca
Show file tree

Hide file tree

Showing 42 changed files with 279 additions and 212 deletions.
diff --git a/src/api/libcellml/generatorprofile.h b/src/api/libcellml/generatorprofile.h
@@ -3122,6 +3122,25 @@ class LIBCELLML_EXPORT GeneratorProfile
      */
     void setAlgebraicArrayString(const std::string &algebraicArrayString);
 
+    /**
+     * @brief Get the @c std::string for the name of the external array.
+     *
+     * Return the @c std::string for the name of the external array.
+     *
+     * @return The @c std::string for the name of the external array.
+     */
+    std::string externalArrayString() const;
+
+    /**
+     * @brief Set the @c std::string for the name of the external array.
+     *
+     * Set the @c std::string for the name of the external array.
+     *
+     * @param externalArrayString The @c std::string to use for the name of the
+     * external array.
+     */
+    void setExternalArrayString(const std::string &externalArrayString);
+
     /**
      * @brief Get the @c std::string for the type definition of an external
      * variable method.

diff --git a/src/bindings/interface/generatorprofile.i b/src/bindings/interface/generatorprofile.i
@@ -860,6 +860,12 @@ and units of a variable respectively.";
 %feature("docstring") libcellml::GeneratorProfile::setAlgebraicArrayString
 "Sets the string for the name of the algebraic array.";
 
+%feature("docstring") libcellml::GeneratorProfile::externalArrayString
+"Returns the string for the name of the external array.";
+
+%feature("docstring") libcellml::GeneratorProfile::setExternalArrayString
+"Sets the string for the name of the external array.";
+
 %feature("docstring") libcellml::GeneratorProfile::externalVariableMethodTypeDefinitionString
 "Returns the string for the type definition of an external variable method.";
 

diff --git a/src/bindings/javascript/generatorprofile.cpp b/src/bindings/javascript/generatorprofile.cpp
@@ -307,6 +307,8 @@ EMSCRIPTEN_BINDINGS(libcellml_generatorprofile)
         .function("setComputedConstantsArrayString", &libcellml::GeneratorProfile::setComputedConstantsArrayString)
         .function("algebraicArrayString", &libcellml::GeneratorProfile::algebraicArrayString)
         .function("setAlgebraicArrayString", &libcellml::GeneratorProfile::setAlgebraicArrayString)
+        .function("externalArrayString", &libcellml::GeneratorProfile::externalArrayString)
+        .function("setExternalArrayString", &libcellml::GeneratorProfile::setExternalArrayString)
         .function("externalVariableMethodTypeDefinitionString", &libcellml::GeneratorProfile::externalVariableMethodTypeDefinitionString)
         .function("setExternalVariableMethodTypeDefinitionString", &libcellml::GeneratorProfile::setExternalVariableMethodTypeDefinitionString)
         .function("externalVariableMethodCallString", &libcellml::GeneratorProfile::externalVariableMethodCallString)

diff --git a/src/generator.cpp b/src/generator.cpp
@@ -764,7 +764,9 @@ void Generator::GeneratorImpl::addNlaSystemsCode()
                                            mProfile->constantsArrayString() :
                                        (variable->type() == AnalyserVariable::Type::COMPUTED_CONSTANT) ?
                                            mProfile->computedConstantsArrayString() :
-                                           mProfile->algebraicArrayString();
+                                       (variable->type() == AnalyserVariable::Type::ALGEBRAIC) ?
+                                           mProfile->algebraicArrayString() :
+                                           mProfile->externalArrayString();
 
                     methodBody += mProfile->indentString()
                                   + arrayString + mProfile->openArrayString() + convertToString(variable->index()) + mProfile->closeArrayString()
@@ -807,7 +809,9 @@ void Generator::GeneratorImpl::addNlaSystemsCode()
                 for (const auto &variable : variables) {
                     auto arrayString = (variable->type() == AnalyserVariable::Type::STATE) ?
                                            mProfile->ratesArrayString() :
-                                           mProfile->algebraicArrayString();
+                                       (variable->type() == AnalyserVariable::Type::ALGEBRAIC) ?
+                                           mProfile->algebraicArrayString() :
+                                           mProfile->externalArrayString();
 
                     methodBody += mProfile->indentString()
                                   + mProfile->uArrayString() + mProfile->openArrayString() + convertToString(++i) + mProfile->closeArrayString()
@@ -831,7 +835,9 @@ void Generator::GeneratorImpl::addNlaSystemsCode()
                 for (const auto &variable : variables) {
                     auto arrayString = (variable->type() == AnalyserVariable::Type::STATE) ?
                                            mProfile->ratesArrayString() :
-                                           mProfile->algebraicArrayString();
+                                       (variable->type() == AnalyserVariable::Type::ALGEBRAIC) ?
+                                           mProfile->algebraicArrayString() :
+                                           mProfile->externalArrayString();
 
                     methodBody += mProfile->indentString()
                                   + arrayString + mProfile->openArrayString() + convertToString(variable->index()) + mProfile->closeArrayString()
@@ -914,8 +920,10 @@ std::string Generator::GeneratorImpl::generateVariableNameCode(const VariablePtr
         arrayName = mProfile->constantsArrayString();
     } else if (analyserVariable->type() == AnalyserVariable::Type::COMPUTED_CONSTANT) {
         arrayName = mProfile->computedConstantsArrayString();
-    } else {
+    } else if (analyserVariable->type() == AnalyserVariable::Type::ALGEBRAIC) {
         arrayName = mProfile->algebraicArrayString();
+    } else {
+        arrayName = mProfile->externalArrayString();
     }
 
     return arrayName + mProfile->openArrayString() + convertToString(analyserVariable->index()) + mProfile->closeArrayString();

diff --git a/src/generatorprofile.cpp b/src/generatorprofile.cpp
@@ -288,6 +288,7 @@ void GeneratorProfile::GeneratorProfileImpl::loadProfile(GeneratorProfile::Profi
         mConstantsArrayString = "constants";
         mComputedConstantsArrayString = "computedConstants";
         mAlgebraicArrayString = "algebraic";
+        mExternalArrayString = "external";
 
         mExternalVariableMethodTypeDefinitionFamString = "typedef double (* ExternalVariable)(double *variables, size_t index);\n";
         mExternalVariableMethodTypeDefinitionFdmString = "typedef double (* ExternalVariable)(double voi, double *states, double *rates, double *variables, size_t index);\n";
@@ -740,6 +741,7 @@ void GeneratorProfile::GeneratorProfileImpl::loadProfile(GeneratorProfile::Profi
         mConstantsArrayString = "constants";
         mComputedConstantsArrayString = "computed_constants";
         mAlgebraicArrayString = "algebraic";
+        mExternalArrayString = "external";
 
         mExternalVariableMethodTypeDefinitionFamString = "";
         mExternalVariableMethodTypeDefinitionFdmString = "";
@@ -2288,6 +2290,16 @@ void GeneratorProfile::setAlgebraicArrayString(const std::string &algebraicArray
     mPimpl->mAlgebraicArrayString = algebraicArrayString;
 }
 
+std::string GeneratorProfile::externalArrayString() const
+{
+    return mPimpl->mExternalArrayString;
+}
+
+void GeneratorProfile::setExternalArrayString(const std::string &externalArrayString)
+{
+    mPimpl->mExternalArrayString = externalArrayString;
+}
+
 std::string GeneratorProfile::externalVariableMethodTypeDefinitionString(bool forDifferentialModel) const
 {
     if (forDifferentialModel) {

diff --git a/src/generatorprofile_p.h b/src/generatorprofile_p.h
@@ -217,6 +217,7 @@ struct GeneratorProfile::GeneratorProfileImpl
     std::string mConstantsArrayString;
     std::string mComputedConstantsArrayString;
     std::string mAlgebraicArrayString;
+    std::string mExternalArrayString;
 
     std::string mExternalVariableMethodTypeDefinitionFamString;
     std::string mExternalVariableMethodTypeDefinitionFdmString;

diff --git a/src/generatorprofilesha1values.h b/src/generatorprofilesha1values.h
@@ -24,7 +24,7 @@ namespace libcellml {
  * The content of this file is generated, do not edit this file directly.
  * See docs/dev_utilities.rst for further information.
  */
-static const char C_GENERATOR_PROFILE_SHA1[] = "2d4d14df0a454d95e32e1172503d529834c42588";
-static const char PYTHON_GENERATOR_PROFILE_SHA1[] = "5ff1e7cc237b3e7eb1153b6d421df842731c6394";
+static const char C_GENERATOR_PROFILE_SHA1[] = "54ee603459d7878ee469890e77de4f3dbb5452ad";
+static const char PYTHON_GENERATOR_PROFILE_SHA1[] = "bf42c06955e401096d76d059a28ed1a5cb1ccc01";
 
 } // namespace libcellml
diff --git a/src/generatorprofiletools.cpp b/src/generatorprofiletools.cpp
@@ -482,7 +482,8 @@ std::string generatorProfileAsString(const GeneratorProfilePtr &generatorProfile
                        + generatorProfile->ratesArrayString()
                        + generatorProfile->constantsArrayString()
                        + generatorProfile->computedConstantsArrayString()
-                       + generatorProfile->algebraicArrayString();
+                       + generatorProfile->algebraicArrayString()
+                       + generatorProfile->externalArrayString();
 
     profileContents += generatorProfile->externalVariableMethodTypeDefinitionString(false)
                        + generatorProfile->externalVariableMethodTypeDefinitionString(true);

diff --git a/tests/bindings/javascript/generator.test.js b/tests/bindings/javascript/generator.test.js
@@ -62,7 +62,7 @@ describe("Generator tests", () => {
         g.setModel(a.model())
 
         const interface_lines = g.interfaceCode().split('\n')
-        expect(interface_lines.length).toBe(37)
+        expect(interface_lines.length).toBe(38)
 
         const implementation_lines = g.implementationCode().split('\n')
         expect(implementation_lines.length).toBe(97)

diff --git a/tests/bindings/javascript/generatorprofile.test.js b/tests/bindings/javascript/generatorprofile.test.js
@@ -915,6 +915,12 @@ describe("GeneratorProfile tests", () => {
     x.setAlgebraicArrayString("something")
     expect(x.algebraicArrayString()).toBe("something")
   });
+  test("Checking GeneratorProfile.externalArrayString.", () => {
+    const x = new libcellml.GeneratorProfile(libcellml.GeneratorProfile.Profile.C)
+
+    x.setExternalArrayString("something")
+    expect(x.externalArrayString()).toBe("something")
+  });
   test("Checking GeneratorProfile.externalVariableMethodTypeDefinitionString.", () => {
     const x = new libcellml.GeneratorProfile(libcellml.GeneratorProfile.Profile.C)
 

diff --git a/tests/bindings/python/test_generator_profile.py b/tests/bindings/python/test_generator_profile.py
@@ -1682,6 +1682,15 @@ def test_algebraic_array_string(self):
         g.setAlgebraicArrayString(GeneratorProfileTestCase.VALUE)
         self.assertEqual(GeneratorProfileTestCase.VALUE, g.algebraicArrayString())
 
+    def test_external_array_string(self):
+        from libcellml import GeneratorProfile
+
+        g = GeneratorProfile()
+
+        self.assertEqual('external', g.externalArrayString())
+        g.setExternalArrayString(GeneratorProfileTestCase.VALUE)
+        self.assertEqual(GeneratorProfileTestCase.VALUE, g.externalArrayString())
+
     def test_external_variable_method_type_definition_string(self):
         from libcellml import GeneratorProfile
 

diff --git a/tests/generator/generatorprofile.cpp b/tests/generator/generatorprofile.cpp
@@ -340,6 +340,7 @@ TEST(GeneratorProfile, defaultMiscellaneousValues)
     EXPECT_EQ("constants", generatorProfile->constantsArrayString());
     EXPECT_EQ("computedConstants", generatorProfile->computedConstantsArrayString());
     EXPECT_EQ("algebraic", generatorProfile->algebraicArrayString());
+    EXPECT_EQ("external", generatorProfile->externalArrayString());
 
     EXPECT_EQ("typedef double (* ExternalVariable)(double *variables, size_t index);\n", generatorProfile->externalVariableMethodTypeDefinitionString(false));
     EXPECT_EQ("typedef double (* ExternalVariable)(double voi, double *states, double *rates, double *variables, size_t index);\n", generatorProfile->externalVariableMethodTypeDefinitionString(true));
@@ -938,6 +939,7 @@ TEST(GeneratorProfile, miscellaneous)
     generatorProfile->setConstantsArrayString(value);
     generatorProfile->setComputedConstantsArrayString(value);
     generatorProfile->setAlgebraicArrayString(value);
+    generatorProfile->setExternalArrayString(value);
 
     generatorProfile->setExternalVariableMethodTypeDefinitionString(false, value);
     generatorProfile->setExternalVariableMethodTypeDefinitionString(true, value);
@@ -1084,6 +1086,7 @@ TEST(GeneratorProfile, miscellaneous)
     EXPECT_EQ(value, generatorProfile->constantsArrayString());
     EXPECT_EQ(value, generatorProfile->computedConstantsArrayString());
     EXPECT_EQ(value, generatorProfile->algebraicArrayString());
+    EXPECT_EQ(value, generatorProfile->externalArrayString());
 
     EXPECT_EQ(value, generatorProfile->externalVariableMethodTypeDefinitionString(false));
     EXPECT_EQ(value, generatorProfile->externalVariableMethodTypeDefinitionString(true));

diff --git a/tests/resources/generator/algebraic_eqn_computed_var_on_rhs/model.external.c b/tests/resources/generator/algebraic_eqn_computed_var_on_rhs/model.external.c
@@ -78,7 +78,7 @@ void deleteArray(double *array)
 
 void initialiseVariables(double *constants, double *algebraic, ExternalVariable externalVariable)
 {
-    algebraic[1] = externalVariable(variables, 1);
+    external[1] = externalVariable(variables, 1);
 }
 
 void computeComputedConstants(double *constants, double *computedConstants)
@@ -87,6 +87,6 @@ void computeComputedConstants(double *constants, double *computedConstants)
 
 void computeVariables(double *constants, double *computedConstants, double *algebraic, ExternalVariable externalVariable)
 {
-    algebraic[1] = externalVariable(variables, 1);
-    algebraic[0] = algebraic[1];
+    external[1] = externalVariable(variables, 1);
+    algebraic[0] = external[1];
 }
diff --git a/tests/resources/generator/algebraic_eqn_computed_var_on_rhs/model.external.py b/tests/resources/generator/algebraic_eqn_computed_var_on_rhs/model.external.py
@@ -44,13 +44,13 @@ def create_externals_array():
 
 
 def initialise_variables(constants, algebraic, external_variable):
-    algebraic[1] = external_variable(variables, 1)
+    external[1] = external_variable(variables, 1)
 
 
 def compute_computed_constants(constants, computed_constants):
     pass
 
 
 def compute_variables(constants, computed_constants, algebraic, external_variable):
-    algebraic[1] = external_variable(variables, 1)
-    algebraic[0] = algebraic[1]
+    external[1] = external_variable(variables, 1)
+    algebraic[0] = external[1]
diff --git a/tests/resources/generator/algebraic_eqn_with_one_non_isolated_unknown/model.external.c b/tests/resources/generator/algebraic_eqn_with_one_non_isolated_unknown/model.external.c
@@ -80,7 +80,7 @@ void deleteArray(double *array)
 
 void initialiseVariables(double *constants, double *algebraic, ExternalVariable externalVariable)
 {
-    algebraic[0] = externalVariable(variables, 0);
+    external[0] = externalVariable(variables, 0);
 }
 
 void computeComputedConstants(double *constants, double *computedConstants)
@@ -92,5 +92,5 @@ void computeComputedConstants(double *constants, double *computedConstants)
 
 void computeVariables(double *constants, double *computedConstants, double *algebraic, ExternalVariable externalVariable)
 {
-    algebraic[0] = externalVariable(variables, 0);
+    external[0] = externalVariable(variables, 0);
 }
diff --git a/tests/resources/generator/algebraic_eqn_with_one_non_isolated_unknown/model.external.py b/tests/resources/generator/algebraic_eqn_with_one_non_isolated_unknown/model.external.py
@@ -46,7 +46,7 @@ def create_externals_array():
 
 
 def initialise_variables(constants, algebraic, external_variable):
-    algebraic[0] = external_variable(variables, 0)
+    external[0] = external_variable(variables, 0)
 
 
 def compute_computed_constants(constants, computed_constants):
@@ -56,4 +56,4 @@ def compute_computed_constants(constants, computed_constants):
 
 
 def compute_variables(constants, computed_constants, algebraic, external_variable):
-    algebraic[0] = external_variable(variables, 0)
+    external[0] = external_variable(variables, 0)
diff --git a/...s/resources/generator/algebraic_system_with_three_linked_unknowns/model.three.externals.c b/...s/resources/generator/algebraic_system_with_three_linked_unknowns/model.three.externals.c
@@ -79,9 +79,9 @@ void deleteArray(double *array)
 
 void initialiseVariables(double *constants, double *algebraic, ExternalVariable externalVariable)
 {
-    algebraic[0] = externalVariable(variables, 0);
-    algebraic[1] = externalVariable(variables, 1);
-    algebraic[2] = externalVariable(variables, 2);
+    external[0] = externalVariable(variables, 0);
+    external[1] = externalVariable(variables, 1);
+    external[2] = externalVariable(variables, 2);
 }
 
 void computeComputedConstants(double *constants, double *computedConstants)
@@ -90,7 +90,7 @@ void computeComputedConstants(double *constants, double *computedConstants)
 
 void computeVariables(double *constants, double *computedConstants, double *algebraic, ExternalVariable externalVariable)
 {
-    algebraic[0] = externalVariable(variables, 0);
-    algebraic[1] = externalVariable(variables, 1);
-    algebraic[2] = externalVariable(variables, 2);
+    external[0] = externalVariable(variables, 0);
+    external[1] = externalVariable(variables, 1);
+    external[2] = externalVariable(variables, 2);
 }
diff --git a/.../resources/generator/algebraic_system_with_three_linked_unknowns/model.three.externals.py b/.../resources/generator/algebraic_system_with_three_linked_unknowns/model.three.externals.py
@@ -45,16 +45,16 @@ def create_externals_array():
 
 
 def initialise_variables(constants, algebraic, external_variable):
-    algebraic[0] = external_variable(variables, 0)
-    algebraic[1] = external_variable(variables, 1)
-    algebraic[2] = external_variable(variables, 2)
+    external[0] = external_variable(variables, 0)
+    external[1] = external_variable(variables, 1)
+    external[2] = external_variable(variables, 2)
 
 
 def compute_computed_constants(constants, computed_constants):
     pass
 
 
 def compute_variables(constants, computed_constants, algebraic, external_variable):
-    algebraic[0] = external_variable(variables, 0)
-    algebraic[1] = external_variable(variables, 1)
-    algebraic[2] = external_variable(variables, 2)
+    external[0] = external_variable(variables, 0)
+    external[1] = external_variable(variables, 1)
+    external[2] = external_variable(variables, 2)
diff --git a/tests/resources/generator/cell_geometry_model/model.external.c b/tests/resources/generator/cell_geometry_model/model.external.c
@@ -80,8 +80,8 @@ void deleteArray(double *array)
 
 void initialiseVariables(double *constants, double *algebraic, ExternalVariable externalVariable)
 {
-    algebraic[1] = externalVariable(variables, 1);
-    algebraic[2] = externalVariable(variables, 2);
+    external[1] = externalVariable(variables, 1);
+    external[2] = externalVariable(variables, 2);
 }
 
 void computeComputedConstants(double *constants, double *computedConstants)
@@ -90,8 +90,8 @@ void computeComputedConstants(double *constants, double *computedConstants)
 
 void computeVariables(double *constants, double *computedConstants, double *algebraic, ExternalVariable externalVariable)
 {
-    algebraic[1] = externalVariable(variables, 1);
-    algebraic[2] = externalVariable(variables, 2);
-    algebraic[0] = 1000.0*3.14*algebraic[2]*algebraic[2]*algebraic[1];
+    external[1] = externalVariable(variables, 1);
+    external[2] = externalVariable(variables, 2);
+    algebraic[0] = 1000.0*3.14*external[2]*external[2]*external[1];
     algebraic[3] = 0.02*algebraic[0];
 }
diff --git a/tests/resources/generator/cell_geometry_model/model.external.py b/tests/resources/generator/cell_geometry_model/model.external.py
@@ -46,16 +46,16 @@ def create_externals_array():
 
 
 def initialise_variables(constants, algebraic, external_variable):
-    algebraic[1] = external_variable(variables, 1)
-    algebraic[2] = external_variable(variables, 2)
+    external[1] = external_variable(variables, 1)
+    external[2] = external_variable(variables, 2)
 
 
 def compute_computed_constants(constants, computed_constants):
     pass
 
 
 def compute_variables(constants, computed_constants, algebraic, external_variable):
-    algebraic[1] = external_variable(variables, 1)
-    algebraic[2] = external_variable(variables, 2)
-    algebraic[0] = 1000.0*3.14*algebraic[2]*algebraic[2]*algebraic[1]
+    external[1] = external_variable(variables, 1)
+    external[2] = external_variable(variables, 2)
+    algebraic[0] = 1000.0*3.14*external[2]*external[2]*external[1]
     algebraic[3] = 0.02*algebraic[0]