add timestep() predefined function akin to resolution()

clinssen · Sep 22, 2024 · cf0363f · cf0363f
1 parent ed55a2c
commit cf0363f
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 18 deletions.
diff --git a/pynestml/cocos/co_co_timestep_function_legally_used.py b/pynestml/cocos/co_co_timestep_function_legally_used.py
@@ -20,17 +20,13 @@
 # along with NEST. If not, see <http://www.gnu.org/licenses/>.
 
 from pynestml.cocos.co_co import CoCo
-from pynestml.meta_model.ast_block_with_variables import ASTBlockWithVariables
-from pynestml.meta_model.ast_equations_block import ASTEquationsBlock
-from pynestml.meta_model.ast_function import ASTFunction
 from pynestml.meta_model.ast_model import ASTModel
-from pynestml.meta_model.ast_on_condition_block import ASTOnConditionBlock
-from pynestml.meta_model.ast_on_receive_block import ASTOnReceiveBlock
 from pynestml.meta_model.ast_simple_expression import ASTSimpleExpression
+from pynestml.meta_model.ast_update_block import ASTUpdateBlock
+from pynestml.symbols.predefined_functions import PredefinedFunctions
 from pynestml.utils.logger import LoggingLevel, Logger
 from pynestml.utils.messages import Messages
 from pynestml.visitors.ast_visitor import ASTVisitor
-from pynestml.symbols.predefined_functions import PredefinedFunctions
 
 
 class CoCoTimestepFuncLegallyUsed(CoCo):
@@ -68,12 +64,12 @@ def visit_simple_expression(self, node):
  while _node:
  _node = _node.get_parent()
 
- if isinstance(_node, ASTEquationsBlock) \
-  or isinstance(_node, ASTBlockWithVariables) \
-  or isinstance(_node, ASTOnReceiveBlock) \
- or isinstance(_node, ASTOnConditionBlock) \
-  or isinstance(_node, ASTFunction) \
-  or isinstance(_node, ASTModel):
+ if isinstance(_node, ASTUpdateBlock):
+ # function was used inside an ``update`` block; everything is OK
+ return
+
+ if isinstance(_node, ASTModel):
+ # we reached the top-level block without running into an ``update`` block on the way --> incorrect usage of the function
  code, message = Messages.get_timestep_function_legally_used()
  Logger.log_message(code=code, message=message, error_position=node.get_source_position(),
  log_level=LoggingLevel.ERROR)
diff --git a/pynestml/codegeneration/printers/latex_function_call_printer.py b/pynestml/codegeneration/printers/latex_function_call_printer.py
@@ -54,7 +54,7 @@ def _print_function_call(self, node: ASTFunctionCall) -> str:
  """
  function_name = node.get_name()
 
- if function_name == PredefinedFunctions.TIME_RESOLUTION:
+ if function_name in [PredefinedFunctions.TIME_RESOLUTION, PredefinedFunctions.TIME_TIMESTEP]:
  # context dependent; we assume the template contains the necessary definitions
  return r'\Delta{}t'
 

diff --git a/pynestml/codegeneration/printers/nest_cpp_function_call_printer.py b/pynestml/codegeneration/printers/nest_cpp_function_call_printer.py
@@ -45,7 +45,7 @@ def _print_function_call_format_string(self, function_call: ASTFunctionCall) ->
  """
  function_name = function_call.get_name()
 
- if function_name == PredefinedFunctions.TIME_RESOLUTION:
+ if function_name in [PredefinedFunctions.TIME_RESOLUTION, PredefinedFunctions.TIME_TIMESTEP]:
  # context dependent; we assume the template contains the necessary definitions
  return '__resolution'
 

diff --git a/pynestml/codegeneration/printers/python_function_call_printer.py b/pynestml/codegeneration/printers/python_function_call_printer.py
@@ -139,7 +139,7 @@ def _print_function_call_format_string(self, function_call: ASTFunctionCall) ->
  if function_call.get_name() == PredefinedFunctions.TIME_STEPS:
  return "steps({!s}, self._timestep)"
 
- if function_call.get_name() == PredefinedFunctions.TIME_RESOLUTION:
+ if function_call.get_name() in [PredefinedFunctions.TIME_RESOLUTION, PredefinedFunctions.TIME_TIMESTEP]:
  return "self._timestep"
 
  if function_call.get_name() == PredefinedFunctions.EMIT_SPIKE:

diff --git a/pynestml/codegeneration/printers/python_stepping_function_function_call_printer.py b/pynestml/codegeneration/printers/python_stepping_function_function_call_printer.py
@@ -47,7 +47,7 @@ def _print_function_call_format_string(self, function_call: ASTFunctionCall) ->
  if function_call.get_name() == PredefinedFunctions.TIME_STEPS:
  return "steps({!s}, node._timestep)"
 
- if function_call.get_name() == PredefinedFunctions.TIME_RESOLUTION:
+ if function_call.get_name() in [PredefinedFunctions.TIME_RESOLUTION, PredefinedFunctions.TIME_TIMESTEP]:
  return "node._timestep"
 
  if function_call.get_name() == PredefinedFunctions.EMIT_SPIKE:

diff --git a/pynestml/codegeneration/printers/spinnaker_c_function_call_printer.py b/pynestml/codegeneration/printers/spinnaker_c_function_call_printer.py
@@ -46,7 +46,7 @@ def print_function_call(self, node: ASTFunctionCall) -> str:
  """
  function_name = node.get_name()
 
- if function_name == PredefinedFunctions.TIME_RESOLUTION:
+ if function_name in [PredefinedFunctions.TIME_RESOLUTION, PredefinedFunctions.TIME_TIMESTEP]:
  # context dependent; we assume the template contains the necessary definitions
  return 'parameter->__h'
 

diff --git a/pynestml/codegeneration/printers/spinnaker_python_function_call_printer.py b/pynestml/codegeneration/printers/spinnaker_python_function_call_printer.py
@@ -47,7 +47,7 @@ def _print_function_call_format_string(self, function_call: ASTFunctionCall) ->
  if function_call.get_name() == PredefinedFunctions.TIME_STEPS:
  return " SpynnakerDataView.get_simulation_time_step_per_ms() * {!s}"
 
- if function_call.get_name() == PredefinedFunctions.TIME_RESOLUTION:
+ if function_call.get_name() in [PredefinedFunctions.TIME_RESOLUTION, PredefinedFunctions.TIME_TIMESTEP]:
  return "timestep"
 
  if function_call.get_name() == PredefinedFunctions.EMIT_SPIKE: