Improve LONGITUDINAL_DIFFUSION. (#1497)

Clean up code comments, improve naming and fix a typo.
BlueBrain · Oct 3, 2024 · a731cc1 · a731cc1
1 parent c5fb9fe
commit a731cc1
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 11 deletions.
diff --git a/src/language/code_generator.cmake b/src/language/code_generator.cmake
@@ -114,7 +114,7 @@ set(AST_GENERATED_SOURCES
     ${PROJECT_BINARY_DIR}/src/ast/linear_block.hpp
     ${PROJECT_BINARY_DIR}/src/ast/local_list_statement.hpp
     ${PROJECT_BINARY_DIR}/src/ast/local_var.hpp
-    ${PROJECT_BINARY_DIR}/src/ast/lon_difuse.hpp
+    ${PROJECT_BINARY_DIR}/src/ast/lon_diffuse.hpp
     ${PROJECT_BINARY_DIR}/src/ast/model.hpp
     ${PROJECT_BINARY_DIR}/src/ast/mutex_lock.hpp
     ${PROJECT_BINARY_DIR}/src/ast/mutex_unlock.hpp

diff --git a/src/language/nmodl.yaml b/src/language/nmodl.yaml
@@ -1546,21 +1546,21 @@
                             separator: " "
                       brief: "Represent COMPARTMENT statement in NMODL"
 
-                  - LonDifuse:
+                  - LonDiffuse:
                       nmodl: LONGITUDINAL_DIFFUSION
                       members:
-                        - name:
-                            brief: "TODO"
+                        - index_name:
+                            brief: "Index variable name"
                             type: Name
                             optional: true
                             prefix: {value: " "}
                             suffix: {value: ","}
-                        - expression:
-                            brief: "TODO"
+                        - rate:
+                            brief: "Diffusion coefficient/rate"
                             type: Expression
                             prefix: {value: " "}
-                        - names:
-                            brief: "TODO"
+                        - species:
+                            brief: "Names of the diffusing species"
                             type: Name
                             vector: true
                             prefix: {value: " {"}

diff --git a/src/parser/nmodl.yy b/src/parser/nmodl.yy
@@ -268,7 +268,7 @@
 %type   <ast::Conserve*>                    conserve
 %type   <ast::Expression*>                  react
 %type   <ast::Compartment*>                 compartment
-%type   <ast::LonDifuse*>                   longitudinal_diffusion
+%type   <ast::LonDiffuse*>                  longitudinal_diffusion
 %type   <ast::NameVector>                   name_list
 %type   <ast::ExpressionVector>             unit_block_body
 %type   <ast::UnitDef*>                     unit_definition
@@ -1723,11 +1723,11 @@ compartment     :   COMPARTMENT NAME_PTR "," expression "{" name_list "}"
 
 longitudinal_diffusion : LONGDIFUS NAME_PTR "," expression "{" name_list "}"
                     {
-                        $$ = new ast::LonDifuse($2, $4, $6);
+                        $$ = new ast::LonDiffuse($2, $4, $6);
                     }
                 |   LONGDIFUS expression "{" name_list "}"
                     {
-                        $$ = new ast::LonDifuse(NULL, $2, $4);
+                        $$ = new ast::LonDiffuse(NULL, $2, $4);
                     }
                 ;