Visitor for printing C++ code compatible with legacy api of CoreNEURON More...

#include <codegen_coreneuron_cpp_visitor.hpp>

Inheritance diagram for nmodl::codegen::CodegenCoreneuronCppVisitor:

Public Member Functions
void	print_instance_variable_setup ()
	Print the function that initialize instance structure. More...

void	print_mechanism_range_var_structure (bool print_initializers) override
	Print the structure that wraps all range and int variables required for the NMODL. More...

	CodegenCppVisitor (std::string mod_filename, std::ostream &stream, std::string float_type, const bool optimize_ionvar_copies, std::unique_ptr< nmodl::utils::Blame > blame=nullptr)
	Constructs the C++ code generator visitor. More...

	CodegenCppVisitor (std::string mod_filename, std::ostream &stream, std::string float_type, const bool optimize_ionvar_copies, const bool enable_cvode, std::unique_ptr< nmodl::utils::Blame > blame=nullptr)

Public Member Functions inherited from nmodl::codegen::CodegenCppVisitor
	CodegenCppVisitor (std::string mod_filename, std::ostream &stream, std::string float_type, const bool optimize_ionvar_copies, std::unique_ptr< nmodl::utils::Blame > blame=nullptr)
	Constructs the C++ code generator visitor. More...

	CodegenCppVisitor (std::string mod_filename, std::ostream &stream, std::string float_type, const bool optimize_ionvar_copies, const bool enable_cvode, std::unique_ptr< nmodl::utils::Blame > blame=nullptr)

void	visit_program (const ast::Program &program) override
	Main and only member function to call after creating an instance of this class. More...

Public Member Functions inherited from nmodl::visitor::ConstAstVisitor
void	visit_node (const ast::Node &node) override
	visit node of type ast::Node More...

void	visit_statement (const ast::Statement &node) override
	visit node of type ast::Statement More...

void	visit_expression (const ast::Expression &node) override
	visit node of type ast::Expression More...

void	visit_block (const ast::Block &node) override
	visit node of type ast::Block More...

void	visit_identifier (const ast::Identifier &node) override
	visit node of type ast::Identifier More...

void	visit_number (const ast::Number &node) override
	visit node of type ast::Number More...

void	visit_string (const ast::String &node) override
	visit node of type ast::String More...

void	visit_integer (const ast::Integer &node) override
	visit node of type ast::Integer More...

void	visit_float (const ast::Float &node) override
	visit node of type ast::Float More...

void	visit_double (const ast::Double &node) override
	visit node of type ast::Double More...

void	visit_boolean (const ast::Boolean &node) override
	visit node of type ast::Boolean More...

void	visit_name (const ast::Name &node) override
	visit node of type ast::Name More...

void	visit_prime_name (const ast::PrimeName &node) override
	visit node of type ast::PrimeName More...

void	visit_indexed_name (const ast::IndexedName &node) override
	visit node of type ast::IndexedName More...

void	visit_var_name (const ast::VarName &node) override
	visit node of type ast::VarName More...

void	visit_argument (const ast::Argument &node) override
	visit node of type ast::Argument More...

void	visit_react_var_name (const ast::ReactVarName &node) override
	visit node of type ast::ReactVarName More...

void	visit_read_ion_var (const ast::ReadIonVar &node) override
	visit node of type ast::ReadIonVar More...

void	visit_write_ion_var (const ast::WriteIonVar &node) override
	visit node of type ast::WriteIonVar More...

void	visit_nonspecific_cur_var (const ast::NonspecificCurVar &node) override
	visit node of type ast::NonspecificCurVar More...

void	visit_electrode_cur_var (const ast::ElectrodeCurVar &node) override
	visit node of type ast::ElectrodeCurVar More...

void	visit_range_var (const ast::RangeVar &node) override
	visit node of type ast::RangeVar More...

void	visit_global_var (const ast::GlobalVar &node) override
	visit node of type ast::GlobalVar More...

void	visit_pointer_var (const ast::PointerVar &node) override
	visit node of type ast::PointerVar More...

void	visit_random_var (const ast::RandomVar &node) override
	visit node of type ast::RandomVar More...

void	visit_bbcore_pointer_var (const ast::BbcorePointerVar &node) override
	visit node of type ast::BbcorePointerVar More...

void	visit_extern_var (const ast::ExternVar &node) override
	visit node of type ast::ExternVar More...

void	visit_param_block (const ast::ParamBlock &node) override
	visit node of type ast::ParamBlock More...

void	visit_independent_block (const ast::IndependentBlock &node) override
	visit node of type ast::IndependentBlock More...

void	visit_assigned_block (const ast::AssignedBlock &node) override
	visit node of type ast::AssignedBlock More...

void	visit_state_block (const ast::StateBlock &node) override
	visit node of type ast::StateBlock More...

void	visit_initial_block (const ast::InitialBlock &node) override
	visit node of type ast::InitialBlock More...

void	visit_constructor_block (const ast::ConstructorBlock &node) override
	visit node of type ast::ConstructorBlock More...

void	visit_destructor_block (const ast::DestructorBlock &node) override
	visit node of type ast::DestructorBlock More...

void	visit_statement_block (const ast::StatementBlock &node) override
	visit node of type ast::StatementBlock More...

void	visit_derivative_block (const ast::DerivativeBlock &node) override
	visit node of type ast::DerivativeBlock More...

void	visit_linear_block (const ast::LinearBlock &node) override
	visit node of type ast::LinearBlock More...

void	visit_non_linear_block (const ast::NonLinearBlock &node) override
	visit node of type ast::NonLinearBlock More...

void	visit_discrete_block (const ast::DiscreteBlock &node) override
	visit node of type ast::DiscreteBlock More...

void	visit_function_table_block (const ast::FunctionTableBlock &node) override
	visit node of type ast::FunctionTableBlock More...

void	visit_function_block (const ast::FunctionBlock &node) override
	visit node of type ast::FunctionBlock More...

void	visit_procedure_block (const ast::ProcedureBlock &node) override
	visit node of type ast::ProcedureBlock More...

void	visit_net_receive_block (const ast::NetReceiveBlock &node) override
	visit node of type ast::NetReceiveBlock More...

void	visit_solve_block (const ast::SolveBlock &node) override
	visit node of type ast::SolveBlock More...

void	visit_breakpoint_block (const ast::BreakpointBlock &node) override
	visit node of type ast::BreakpointBlock More...

void	visit_before_block (const ast::BeforeBlock &node) override
	visit node of type ast::BeforeBlock More...

void	visit_after_block (const ast::AfterBlock &node) override
	visit node of type ast::AfterBlock More...

void	visit_ba_block (const ast::BABlock &node) override
	visit node of type ast::BABlock More...

void	visit_for_netcon (const ast::ForNetcon &node) override
	visit node of type ast::ForNetcon More...

void	visit_kinetic_block (const ast::KineticBlock &node) override
	visit node of type ast::KineticBlock More...

void	visit_unit_block (const ast::UnitBlock &node) override
	visit node of type ast::UnitBlock More...

void	visit_constant_block (const ast::ConstantBlock &node) override
	visit node of type ast::ConstantBlock More...

void	visit_neuron_block (const ast::NeuronBlock &node) override
	visit node of type ast::NeuronBlock More...

void	visit_unit (const ast::Unit &node) override
	visit node of type ast::Unit More...

void	visit_double_unit (const ast::DoubleUnit &node) override
	visit node of type ast::DoubleUnit More...

void	visit_local_var (const ast::LocalVar &node) override
	visit node of type ast::LocalVar More...

void	visit_limits (const ast::Limits &node) override
	visit node of type ast::Limits More...

void	visit_number_range (const ast::NumberRange &node) override
	visit node of type ast::NumberRange More...

void	visit_constant_var (const ast::ConstantVar &node) override
	visit node of type ast::ConstantVar More...

void	visit_binary_operator (const ast::BinaryOperator &node) override
	visit node of type ast::BinaryOperator More...

void	visit_unary_operator (const ast::UnaryOperator &node) override
	visit node of type ast::UnaryOperator More...

void	visit_reaction_operator (const ast::ReactionOperator &node) override
	visit node of type ast::ReactionOperator More...

void	visit_paren_expression (const ast::ParenExpression &node) override
	visit node of type ast::ParenExpression More...

void	visit_binary_expression (const ast::BinaryExpression &node) override
	visit node of type ast::BinaryExpression More...

void	visit_diff_eq_expression (const ast::DiffEqExpression &node) override
	visit node of type ast::DiffEqExpression More...

void	visit_unary_expression (const ast::UnaryExpression &node) override
	visit node of type ast::UnaryExpression More...

void	visit_non_lin_equation (const ast::NonLinEquation &node) override
	visit node of type ast::NonLinEquation More...

void	visit_lin_equation (const ast::LinEquation &node) override
	visit node of type ast::LinEquation More...

void	visit_function_call (const ast::FunctionCall &node) override
	visit node of type ast::FunctionCall More...

void	visit_watch (const ast::Watch &node) override
	visit node of type ast::Watch More...

void	visit_ba_block_type (const ast::BABlockType &node) override
	visit node of type ast::BABlockType More...

void	visit_unit_def (const ast::UnitDef &node) override
	visit node of type ast::UnitDef More...

void	visit_factor_def (const ast::FactorDef &node) override
	visit node of type ast::FactorDef More...

void	visit_valence (const ast::Valence &node) override
	visit node of type ast::Valence More...

void	visit_unit_state (const ast::UnitState &node) override
	visit node of type ast::UnitState More...

void	visit_local_list_statement (const ast::LocalListStatement &node) override
	visit node of type ast::LocalListStatement More...

void	visit_model (const ast::Model &node) override
	visit node of type ast::Model More...

void	visit_define (const ast::Define &node) override
	visit node of type ast::Define More...

void	visit_include (const ast::Include &node) override
	visit node of type ast::Include More...

void	visit_param_assign (const ast::ParamAssign &node) override
	visit node of type ast::ParamAssign More...

void	visit_assigned_definition (const ast::AssignedDefinition &node) override
	visit node of type ast::AssignedDefinition More...

void	visit_conductance_hint (const ast::ConductanceHint &node) override
	visit node of type ast::ConductanceHint More...

void	visit_expression_statement (const ast::ExpressionStatement &node) override
	visit node of type ast::ExpressionStatement More...

void	visit_protect_statement (const ast::ProtectStatement &node) override
	visit node of type ast::ProtectStatement More...

void	visit_from_statement (const ast::FromStatement &node) override
	visit node of type ast::FromStatement More...

void	visit_while_statement (const ast::WhileStatement &node) override
	visit node of type ast::WhileStatement More...

void	visit_if_statement (const ast::IfStatement &node) override
	visit node of type ast::IfStatement More...

void	visit_else_if_statement (const ast::ElseIfStatement &node) override
	visit node of type ast::ElseIfStatement More...

void	visit_else_statement (const ast::ElseStatement &node) override
	visit node of type ast::ElseStatement More...

void	visit_watch_statement (const ast::WatchStatement &node) override
	visit node of type ast::WatchStatement More...

void	visit_mutex_lock (const ast::MutexLock &node) override
	visit node of type ast::MutexLock More...

void	visit_mutex_unlock (const ast::MutexUnlock &node) override
	visit node of type ast::MutexUnlock More...

void	visit_conserve (const ast::Conserve &node) override
	visit node of type ast::Conserve More...

void	visit_compartment (const ast::Compartment &node) override
	visit node of type ast::Compartment More...

void	visit_lon_diffuse (const ast::LonDiffuse &node) override
	visit node of type ast::LonDiffuse More...

void	visit_reaction_statement (const ast::ReactionStatement &node) override
	visit node of type ast::ReactionStatement More...

void	visit_lag_statement (const ast::LagStatement &node) override
	visit node of type ast::LagStatement More...

void	visit_constant_statement (const ast::ConstantStatement &node) override
	visit node of type ast::ConstantStatement More...

void	visit_table_statement (const ast::TableStatement &node) override
	visit node of type ast::TableStatement More...

void	visit_suffix (const ast::Suffix &node) override
	visit node of type ast::Suffix More...

void	visit_useion (const ast::Useion &node) override
	visit node of type ast::Useion More...

void	visit_nonspecific (const ast::Nonspecific &node) override
	visit node of type ast::Nonspecific More...

void	visit_electrode_current (const ast::ElectrodeCurrent &node) override
	visit node of type ast::ElectrodeCurrent More...

void	visit_range (const ast::Range &node) override
	visit node of type ast::Range More...

void	visit_global (const ast::Global &node) override
	visit node of type ast::Global More...

void	visit_random_var_list (const ast::RandomVarList &node) override
	visit node of type ast::RandomVarList More...

void	visit_pointer (const ast::Pointer &node) override
	visit node of type ast::Pointer More...

void	visit_bbcore_pointer (const ast::BbcorePointer &node) override
	visit node of type ast::BbcorePointer More...

void	visit_external (const ast::External &node) override
	visit node of type ast::External More...

void	visit_thread_safe (const ast::ThreadSafe &node) override
	visit node of type ast::ThreadSafe More...

void	visit_verbatim (const ast::Verbatim &node) override
	visit node of type ast::Verbatim More...

void	visit_line_comment (const ast::LineComment &node) override
	visit node of type ast::LineComment More...

void	visit_block_comment (const ast::BlockComment &node) override
	visit node of type ast::BlockComment More...

void	visit_ontology_statement (const ast::OntologyStatement &node) override
	visit node of type ast::OntologyStatement More...

void	visit_program (const ast::Program &node) override
	visit node of type ast::Program More...

void	visit_nrn_state_block (const ast::NrnStateBlock &node) override
	visit node of type ast::NrnStateBlock More...

void	visit_eigen_newton_solver_block (const ast::EigenNewtonSolverBlock &node) override
	visit node of type ast::EigenNewtonSolverBlock More...

void	visit_eigen_linear_solver_block (const ast::EigenLinearSolverBlock &node) override
	visit node of type ast::EigenLinearSolverBlock More...

void	visit_matexp_block (const ast::MatexpBlock &node) override
	visit node of type ast::MatexpBlock More...

void	visit_cvode_block (const ast::CvodeBlock &node) override
	visit node of type ast::CvodeBlock More...

void	visit_longitudinal_diffusion_block (const ast::LongitudinalDiffusionBlock &node) override
	visit node of type ast::LongitudinalDiffusionBlock More...

void	visit_wrapped_expression (const ast::WrappedExpression &node) override
	visit node of type ast::WrappedExpression More...

void	visit_derivimplicit_callback (const ast::DerivimplicitCallback &node) override
	visit node of type ast::DerivimplicitCallback More...

void	visit_solution_expression (const ast::SolutionExpression &node) override
	visit node of type ast::SolutionExpression More...

void	visit_update_dt (const ast::UpdateDt &node) override
	visit node of type ast::UpdateDt More...

Public Member Functions inherited from nmodl::visitor::ConstVisitor
virtual	~ConstVisitor ()=default

Protected Member Functions
std::string	simulator_name () override
	Name of the simulator the code was generated for. More...

std::string	backend_name () const override
	Name of the code generation backend. More...

int	num_thread_objects () const noexcept
	Determine the number of threads to allocate. More...

bool	needs_v_unused () const override

int	position_of_float_var (const std::string &name) const override
	Determine the position in the data array for a given float variable. More...

int	position_of_int_var (const std::string &name) const override
	Determine the position in the data array for a given int variable. More...

std::string	process_verbatim_token (const std::string &token)
	Process a token in a verbatim block for possible variable renaming. More...

virtual bool	is_constant_variable (const std::string &name) const
	Check if variable is qualified as constant. More...

virtual void	print_deriv_advance_flag_transfer_to_device () const
	Print the code to copy derivative advance flag to device. More...

virtual void	print_device_atomic_capture_annotation () const
	Print pragma annotation for increase and capture of variable in automatic way. More...

virtual void	print_net_send_buf_count_update_to_host () const
	Print the code to update NetSendBuffer_t count from device to host. More...

virtual void	print_net_send_buf_update_to_host () const
	Print the code to update NetSendBuffer_t from device to host. More...

virtual void	print_net_send_buf_count_update_to_device () const
	Print the code to update NetSendBuffer_t count from host to device. More...

virtual void	print_dt_update_to_device () const
	Print the code to update dt from host to device. More...

virtual void	print_device_stream_wait () const
	Print the code to synchronise/wait on stream specific to NrnThread. More...

virtual void	print_kernel_data_present_annotation_block_begin ()
	Print accelerator annotations indicating data presence on device. More...

virtual void	print_kernel_data_present_annotation_block_end ()
	Print matching block end of accelerator annotations for data presence on device. More...

virtual void	print_net_init_acc_serial_annotation_block_begin ()
	Print accelerator kernels begin annotation for net_init kernel. More...

virtual void	print_net_init_acc_serial_annotation_block_end ()
	Print accelerator kernels end annotation for net_init kernel. More...

virtual bool	nrn_cur_reduction_loop_required ()
	Check if reduction block in `nrn_cur` required. More...

virtual void	print_rhs_d_shadow_variables ()
	Print the setup method for setting matrix shadow vectors. More...

virtual void	print_nrn_cur_matrix_shadow_update ()
	Print the update to matrix elements with/without shadow vectors. More...

virtual void	print_nrn_cur_matrix_shadow_reduction ()
	Print the reduction to matrix elements from shadow vectors. More...

virtual void	print_atomic_reduction_pragma ()
	Print atomic update pragma for reduction statements. More...

virtual void	print_global_method_annotation ()
	Print backend specific global method annotation. More...

virtual void	print_backend_includes ()
	Print backend specific includes (none needed for C++ backend) More...

bool	optimize_ion_variable_copies () const override
	Check if ion variable copies should be avoided. More...

virtual void	print_memory_allocation_routine () const
	Print memory allocation routine. More...

virtual void	print_abort_routine () const
	Print backend specific abort routine. More...

virtual void	print_instance_struct_transfer_routine_declarations ()
	Print declarations of the functions used by print_instance_struct_copy_to_device and print_instance_struct_delete_from_device. More...

virtual void	print_instance_struct_transfer_routines (std::vector< std::string > const &)
	Print the definitions of the functions used by print_instance_struct_copy_to_device and print_instance_struct_delete_from_device. More...

virtual void	print_instance_struct_copy_to_device ()
	Transfer the instance struct to the device. More...

virtual void	print_instance_struct_delete_from_device ()
	Delete the instance struct from the device. More...

void	print_function_prototypes () override
	Print function and procedures prototype declaration. More...

void	print_check_table_thread_function ()
	Print check_table functions. More...

void	print_function_or_procedure (const ast::Block &node, const std::string &name, const std::unordered_set< CppObjectSpecifier > &specifiers={ CppObjectSpecifier::Inline}) override
	Print nmodl function or procedure (common code) More...

void	print_function_procedure_helper (const ast::Block &node) override
	Common helper function to help printing function or procedure blocks. More...

void	add_variable_tqitem (std::vector< IndexVariableInfo > &variables) override
	Add the variable tqitem during `get_int_variables`. More...

void	add_variable_point_process (std::vector< IndexVariableInfo > &variables) override
	Add the variable point_process during `get_int_variables`. More...

std::string	internal_method_arguments () override
	Arguments for functions that are defined and used internally. More...

ParamVector	internal_method_parameters () override
	Parameters for internally defined functions. More...

const std::string	external_method_arguments () noexcept override
	Arguments for external functions called from generated code. More...

const ParamVector	external_method_parameters (bool table=false) noexcept override
	Parameters for functions in generated code that are called back from external code. More...

std::string	nrn_thread_arguments () const override
	Arguments for "_threadargs_" macro in neuron implementation. More...

std::string	nrn_thread_internal_arguments () override
	Arguments for "_threadargs_" macro in neuron implementation. More...

std::pair< ParamVector, ParamVector >	function_table_parameters (const ast::FunctionTableBlock &node) override
	Parameters of the function itself `"{}"` and `"table_{}"`. More...

std::string	replace_if_verbatim_variable (std::string name)
	Replace commonly used verbatim variables. More...

std::string	process_verbatim_text (std::string const &text)
	Process a verbatim block for possible variable renaming. More...

std::string	register_mechanism_arguments () const override
	Arguments for register_mech or point_register_mech function. More...

void	append_conc_write_statements (std::vector< ShadowUseStatement > &statements, const Ion &ion, const std::string &concentration) override
	Generate Function call statement for nrn_wrote_conc. More...

void	print_first_pointer_var_index_getter ()
	Print the getter method for index position of first pointer variable. More...

void	print_first_random_var_index_getter ()
	Print the getter method for index position of first RANDOM variable. More...

void	print_num_variable_getter ()
	Print the getter methods for float and integer variables count. More...

void	print_net_receive_arg_size_getter ()
	Print the getter method for getting number of arguments for net_receive. More...

void	print_mech_type_getter ()
	Print the getter method for returning mechtype. More...

void	print_memb_list_getter ()
	Print the getter method for returning membrane list from NrnThread. More...

virtual std::string	namespace_name () override
	Name of "our" namespace. More...

void	print_thread_getters ()
	Print the getter method for thread variables and ids. More...

std::string	float_variable_name (const SymbolType &symbol, bool use_instance) const override
	Determine the name of a `float` variable given its symbol. More...

std::string	int_variable_name (const IndexVariableInfo &symbol, const std::string &name, bool use_instance) const override
	Determine the name of an `int` variable given its symbol. More...

std::string	global_variable_name (const SymbolType &symbol, bool use_instance=true) const override
	Determine the variable name for a global variable given its symbol. More...

std::string	get_variable_name (const std::string &name, bool use_instance=true) const override
	Determine variable name in the structure of mechanism properties. More...

void	print_standard_includes () override
	Print standard C/C++ includes. More...

void	print_coreneuron_includes ()
	Print includes from coreneuron. More...

void	print_sdlists_init (bool print_initializers) override

void	print_mechanism_global_var_structure (bool print_initializers) override
	Print the structure that wraps all global variables used in the NMODL. More...

void	print_global_variables_for_hoc () override
	Print byte arrays that register scalar and vector variables for hoc interface. More...

void	print_mechanism_register () override
	Print the mechanism registration function. More...

void	print_thread_memory_callbacks ()
	Print thread related memory allocation and deallocation callbacks. More...

void	print_ion_var_structure ()
	Print structure of ion variables used for local copies. More...

virtual void	print_ion_var_constructor (const std::vector< std::string > &members)
	Print constructor of ion variables. More...

void	print_ion_variable () override
	Print the ion variable struct. More...

virtual void	print_global_variable_device_update_annotation ()
	Print the pragma annotation to update global variables from host to the device. More...

void	print_setup_range_variable ()
	Print the function that initialize range variable with different data type. More...

std::string	get_range_var_float_type (const SymbolType &symbol)
	Returns floating point type for given range variable symbol. More...

void	print_initial_block (const ast::InitialBlock *node)
	Print initial block statements. More...

virtual void	print_global_function_common_code (BlockType type, const std::string &function_name="") override
	Print common code for global functions like nrn_init, nrn_cur and nrn_state. More...

void	print_nrn_init (bool skip_init_check=true)
	Print the `nrn_init` function definition. More...

virtual void	print_before_after_block (const ast::Block *node, size_t block_id)
	Print NMODL before / after block in target backend code. More...

void	print_nrn_constructor () override
	Print nrn_constructor function definition. More...

void	print_nrn_destructor () override
	Print nrn_destructor function definition. More...

void	print_nrn_alloc () override
	Print nrn_alloc function definition. More...

void	print_watch_activate ()
	Print watch activate function. More...

void	print_watch_check ()
	Print watch activate function. More...

void	print_net_receive_common_code (const ast::Block &node, bool need_mech_inst=true)
	Print the common code section for net receive related methods. More...

void	print_net_send_call (const ast::FunctionCall &node) override
	Print call to `net_send`. More...

void	print_net_move_call (const ast::FunctionCall &node) override
	Print call to net_move. More...

void	print_net_event_call (const ast::FunctionCall &node) override
	Print call to net_event. More...

void	print_function_table_call (const ast::FunctionCall &node) override
	Print special code when calling FUNCTION_TABLEs. More...

void	print_net_init ()
	Print initial block in the net receive block. More...

void	print_send_event_move ()
	Print send event move block used in net receive as well as watch. More...

virtual std::string	net_receive_buffering_declaration ()
	Generate the target backend code for the `net_receive_buffering` function delcaration. More...

virtual void	print_get_memb_list ()
	Print the target backend code for defining and checking a local `Memb_list` variable. More...

virtual void	print_net_receive_loop_begin ()
	Print the code for the main `net_receive` loop. More...

virtual void	print_net_receive_loop_end ()
	Print the code for closing the main `net_receive` loop. More...

void	print_net_receive_buffering (bool need_mech_inst=true)
	Print kernel for buffering net_receive events. More...

virtual void	print_net_send_buffering_cnt_update () const
	Print the code related to the update of NetSendBuffer_t cnt. More...

virtual void	print_net_send_buffering_grow ()
	Print statement that grows NetSendBuffering_t structure if needed. More...

void	print_net_send_buffering ()
	Print kernel for buffering net_send events. More...

void	print_net_receive_kernel ()
	Print `net_receive` kernel function definition. More...

void	print_net_receive ()
	Print `net_receive` function definition. More...

void	print_derivimplicit_kernel (const ast::Block &block)
	Print derivative kernel when `derivimplicit` method is used. More...

virtual void	print_newtonspace_transfer_to_device () const
	Print code block to transfer newtonspace structure to device. More...

void	print_nrn_state () override
	Print nrn_state / state update function definition. More...

void	print_nrn_current (const ast::BreakpointBlock &node) override
	Print the `nrn_current` kernel. More...

void	print_nrn_cur_conductance_kernel (const ast::BreakpointBlock &node) override
	Print the `nrn_cur` kernel with NMODL `conductance` keyword provisions. More...

void	print_nrn_cur_non_conductance_kernel () override
	Print the `nrn_cur` kernel without NMODL `conductance` keyword provisions. More...

void	print_nrn_cur_kernel (const ast::BreakpointBlock &node) override
	Print main body of nrn_cur function. More...

void	print_fast_imem_calculation () override
	Print fast membrane current calculation code. More...

void	print_nrn_cur () override
	Print nrn_cur / current update function definition. More...

void	print_headers_include () override
	Print all includes. More...

void	print_common_getters ()
	Print common getters. More...

void	print_data_structures (bool print_initializers) override
	Print all classes. More...

void	print_v_unused () const override
	Set v_unused (voltage) for NRN_PRCELLSTATE feature. More...

void	print_g_unused () const override
	Set g_unused (conductance) for NRN_PRCELLSTATE feature. More...

void	print_compute_functions () override
	Print all compute functions for every backend. More...

void	print_codegen_routines () override
	Print entry point to code generation. More...

void	visit_derivimplicit_callback (const ast::DerivimplicitCallback &node) override
	visit node of type ast::DerivimplicitCallback More...

void	visit_for_netcon (const ast::ForNetcon &node) override
	visit node of type ast::ForNetcon More...

void	visit_verbatim (const ast::Verbatim &node) override
	visit node of type ast::Verbatim More...

void	visit_watch_statement (const ast::WatchStatement &node) override
	visit node of type ast::WatchStatement More...

void	visit_protect_statement (const ast::ProtectStatement &node) override
	visit node of type ast::ProtectStatement More...

ParamVector	functor_params () override
	The parameters of the Newton solver "functor". More...

Protected Member Functions inherited from nmodl::codegen::CodegenCppVisitor
std::string	nmodl_version () const noexcept
	Return Nmodl language version. More...

std::string	instance_struct () const
	Name of structure that wraps range variables. More...

std::string	node_data_struct () const
	Name of structure that wraps node variables. More...

std::string	thread_variables_struct () const

std::string	global_struct () const
	Name of structure that wraps global variables. More...

std::string	global_struct_instance () const
	Name of the (host-only) global instance of `global_struct` More...

const char *	local_var_type () const noexcept
	Data type for the local variables. More...

const char *	default_float_data_type () const noexcept
	Default data type for floating point elements. More...

const std::string &	float_data_type () const noexcept
	Data type for floating point elements specified on command line. More...

const char *	default_int_data_type () const noexcept
	Default data type for integer (offset) elements. More...

const char *	operator_for_rhs () const noexcept
	Operator for rhs vector update (matrix update) More...

const char *	operator_for_d () const noexcept
	Operator for diagonal vector update (matrix update) More...

std::string	get_channel_info_var_name () const noexcept
	Name of channel info variable. More...

bool	ion_variable_struct_required () const
	Check if a structure for ion variables is required. More...

template<typename T >
bool	has_parameter_of_name (const T &node, const std::string &name)
	Check if function or procedure node has parameter with given name. More...

bool	net_send_buffer_required () const noexcept
	Check if net_send_buffer is required. More...

bool	net_receive_buffering_required () const noexcept
	Check if net receive/send buffering kernels required. More...

bool	nrn_state_required () const noexcept
	Check if nrn_state function is required. More...

bool	nrn_cur_required () const noexcept
	Check if nrn_cur function is required. More...

bool	net_receive_required () const noexcept
	Check if net_receive function is required. More...

bool	range_variable_setup_required () const noexcept
	Check if setup_range_variable function is required. More...

bool	net_receive_exist () const noexcept
	Check if net_receive node exist. More...

bool	breakpoint_exist () const noexcept
	Check if breakpoint node exist. More...

bool	defined_method (const std::string &name) const
	Check if given method is defined in this model. More...

bool	is_net_send (const std::string &name) const noexcept
	Checks if given function name is `net_send`. More...

bool	is_nrn_pointing (const std::string &name) const noexcept

bool	is_net_move (const std::string &name) const noexcept
	Checks if given function name is `net_move`. More...

bool	is_net_event (const std::string &name) const noexcept
	Checks if given function name is `net_event`. More...

bool	is_function_table_call (const std::string &name) const

int	float_variables_size () const
	Number of float variables in the model. More...

int	int_variables_size () const
	Number of integer variables in the model. More...

std::string	format_double_string (const std::string &value)
	Convert a given `double` value to its string representation. More...

std::string	format_float_string (const std::string &value)
	Convert a given `float` value to its string representation. More...

void	update_index_semantics ()
	populate all index semantics needed for registration with coreneuron More...

std::vector< SymbolType >	get_float_variables () const
	Determine all `float` variables required during code generation. More...

std::vector< IndexVariableInfo >	get_int_variables ()
	Determine all `int` variables required during code generation. More...

std::vector< std::string >	ion_read_statements (BlockType type) const
	For a given output block type, return statements for all read ion variables. More...

std::vector< std::string >	ion_read_statements_optimized (BlockType type) const
	For a given output block type, return minimal statements for all read ion variables. More...

std::vector< ShadowUseStatement >	ion_write_statements (BlockType type)
	For a given output block type, return statements for writing back ion variables. More...

std::string	process_shadow_update_statement (const ShadowUseStatement &statement, BlockType type)
	Process shadow update statement. More...

std::string	breakpoint_current (std::string current) const
	Determine the variable name for the "current" used in breakpoint block taking into account intermediate code transformations. More...

virtual void	print_parallel_iteration_hint (BlockType type, const ast::Block *block)
	Print pragma annotations for channel iterations. More...

virtual void	print_global_var_struct_decl ()
	Instantiate global var instance. More...

void	print_statement_block (const ast::StatementBlock &node, bool open_brace=true, bool close_brace=true)
	Print any statement block in nmodl with option to (not) print braces. More...

virtual void	print_function_call (const ast::FunctionCall &node)
	Print call to internal or external function. More...

virtual void	print_nrn_pointing (const ast::FunctionCall &node)
	Print `nrn_pointing`. More...

void	print_procedure (const ast::ProcedureBlock &node)
	Print NMODL procedure in target backend code. More...

void	print_function (const ast::FunctionBlock &node)
	Print NMODL function in target backend code. More...

void	print_function_tables (const ast::FunctionTableBlock &node)
	Print the internal function for FUNCTION_TABLES. More...

bool	is_functor_const (const ast::StatementBlock &variable_block, const ast::StatementBlock &functor_block)
	Checks whether the functor_block generated by sympy solver modifies any variable outside its scope. More...

void	print_functor_definition (const ast::EigenNewtonSolverBlock &node)
	Based on the `EigenNewtonSolverBlock` passed print the definition needed for its functor. More...

void	print_functors_definitions ()
	Print all Newton functor structs. More...

void	print_eigen_linear_solver (const std::string &float_type, int N)
	Print linear solver using Eigen. More...

template<typename T >
void	print_vector_elements (const std::vector< T > &elements, const std::string &separator, const std::string &prefix="")
	Print the items in a vector as a list. More...

std::string	add_escape_quote (const std::string &text) const
	Add quotes to string to be output. More...

std::string	method_name (const std::string &name) const
	Constructs the name of a function or procedure. More...

std::tuple< bool, int >	check_if_var_is_array (const std::string &name)
	Check if the given name exist in the symbol. More...

SymbolType	make_symbol (const std::string &name) const
	Creates a temporary symbol. More...

void	print_namespace_start ()
	Prints the start of the simulator namespace. More...

void	print_namespace_stop ()
	Prints the end of the simulator namespace. More...

void	print_using_namespace ()
	Prints f"using namespace {namespace_name()}". More...

std::string	update_if_ion_variable_name (const std::string &name) const
	Determine the updated name if the ion variable has been optimized. More...

std::string	table_update_function_name (const std::string &block_name) const
	The name of the function that updates the table value if the parameters changed. More...

int	get_int_variable_index (const std::string &var_name)

void	print_backend_info ()
	Print top file header printed in generated code. More...

virtual void	print_global_var_struct_assertions () const
	Print static assertions about the global variable struct. More...

virtual void	print_global_struct_function_table_ptrs ()
	Print the entries of for FUNCTION_TABLEs in the global struct. More...

void	print_prcellstate_macros () const
	Print declaration of macro NRN_PRCELLSTATE for debugging. More...

void	print_mechanism_info ()
	Print backend code for byte array that has mechanism information (to be registered with NEURON/CoreNEURON) More...

void	print_nmodl_constants ()
	Print the nmodl constants used in backend code. More...

void	print_top_verbatim_blocks ()
	Print top level (global scope) verbatim blocks. More...

void	visit_binary_expression (const ast::BinaryExpression &node) override
	visit node of type ast::BinaryExpression More...

void	visit_binary_operator (const ast::BinaryOperator &node) override
	visit node of type ast::BinaryOperator More...

void	visit_boolean (const ast::Boolean &node) override
	visit node of type ast::Boolean More...

void	visit_double (const ast::Double &node) override
	visit node of type ast::Double More...

void	visit_else_if_statement (const ast::ElseIfStatement &node) override
	visit node of type ast::ElseIfStatement More...

void	visit_else_statement (const ast::ElseStatement &node) override
	visit node of type ast::ElseStatement More...

void	visit_float (const ast::Float &node) override
	visit node of type ast::Float More...

void	visit_from_statement (const ast::FromStatement &node) override
	visit node of type ast::FromStatement More...

void	visit_function_call (const ast::FunctionCall &node) override
	visit node of type ast::FunctionCall More...

void	visit_if_statement (const ast::IfStatement &node) override
	visit node of type ast::IfStatement More...

void	visit_indexed_name (const ast::IndexedName &node) override
	visit node of type ast::IndexedName More...

void	visit_integer (const ast::Integer &node) override
	visit node of type ast::Integer More...

void	visit_local_list_statement (const ast::LocalListStatement &node) override
	visit node of type ast::LocalListStatement More...

void	visit_name (const ast::Name &node) override
	visit node of type ast::Name More...

void	visit_paren_expression (const ast::ParenExpression &node) override
	visit node of type ast::ParenExpression More...

void	visit_prime_name (const ast::PrimeName &node) override
	visit node of type ast::PrimeName More...

void	visit_statement_block (const ast::StatementBlock &node) override

void	visit_string (const ast::String &node) override
	visit node of type ast::String More...

void	visit_unary_operator (const ast::UnaryOperator &node) override
	visit node of type ast::UnaryOperator More...

void	visit_unit (const ast::Unit &node) override
	visit node of type ast::Unit More...

void	visit_var_name (const ast::VarName &node) override

void	visit_while_statement (const ast::WhileStatement &node) override
	visit node of type ast::WhileStatement More...

void	visit_update_dt (const ast::UpdateDt &node) override
	visit node of type ast::UpdateDt More...

void	visit_mutex_lock (const ast::MutexLock &node) override
	visit node of type ast::MutexLock More...

void	visit_mutex_unlock (const ast::MutexUnlock &node) override
	visit node of type ast::MutexUnlock More...

void	visit_solution_expression (const ast::SolutionExpression &node) override
	visit node of type ast::SolutionExpression More...

void	visit_eigen_newton_solver_block (const ast::EigenNewtonSolverBlock &node) override
	visit node of type ast::EigenNewtonSolverBlock More...

void	visit_eigen_linear_solver_block (const ast::EigenLinearSolverBlock &node) override
	visit node of type ast::EigenLinearSolverBlock More...

void	visit_matexp_block (const ast::MatexpBlock &node) override
	visit node of type ast::MatexpBlock More...

std::string	compute_method_name (BlockType type) const

virtual void	setup (const ast::Program &node)

void	print_table_replacement_function (const ast::Block &)
	Print replacement function for function or procedure using table. More...

void	print_table_check_function (const ast::Block &)
	Print `check_function()` for functions or procedure using table. More...

const ast::TableStatement *	get_table_statement (const ast::Block &)

std::string	get_object_specifiers (const std::unordered_set< CppObjectSpecifier > &)

template<typename T >
void	print_function_declaration (const T &node, const std::string &name, const std::unordered_set< CppObjectSpecifier > &={CppObjectSpecifier::Static, CppObjectSpecifier::Inline})
	Print prototype declarations of functions or procedures. More...

void	print_rename_state_vars () const

Additional Inherited Members
Protected Types inherited from nmodl::codegen::CodegenCppVisitor
using	SymbolType = std::shared_ptr< symtab::Symbol >

using	ParamVector = std::vector< std::tuple< std::string, std::string, std::string, std::string > >
	A vector of parameters represented by a 4-tuple of strings: More...

Static Protected Member Functions inherited from nmodl::codegen::CodegenCppVisitor
static bool	need_semicolon (const ast::Statement &node)
	Check if a semicolon is required at the end of given statement. More...

static std::string	get_parameter_str (const ParamVector &params)
	Generate the string representing the procedure parameter declaration. More...

static std::string	get_arg_str (const ParamVector &params)
	Generate the string representing the parameters in a function call. More...

static bool	statement_to_skip (const ast::Statement &node)
	Check if given statement should be skipped during code generation. More...

static std::pair< std::string, std::string >	read_ion_variable_name (const std::string &name)
	Return ion variable name and corresponding ion read variable name. More...

static std::pair< std::string, std::string >	write_ion_variable_name (const std::string &name)
	Return ion variable name and corresponding ion write variable name. More...

Protected Attributes inherited from nmodl::codegen::CodegenCppVisitor
std::unique_ptr< CodePrinter >	printer
	Code printer object for target (C++) More...

std::string	mod_filename
	Name of mod file (without .mod suffix) More...

std::string	float_type = codegen::naming::DEFAULT_FLOAT_TYPE
	Data type of floating point variables. More...

bool	optimize_ionvar_copies = true
	Flag to indicate if visitor should avoid ion variable copies. More...

codegen::CodegenInfo	info
	All ast information for code generation. More...

symtab::SymbolTable *	program_symtab = nullptr
	Symbol table for the program. More...

std::vector< SymbolType >	codegen_float_variables
	All float variables for the model. More...

std::vector< IndexVariableInfo >	codegen_int_variables
	All int variables for the model. More...

std::vector< SymbolType >	codegen_global_variables
	All global variables for the model. More...

bool	enable_variable_name_lookup = true
	Variable name should be converted to instance name (but not for function arguments) More...

bool	printing_net_receive = false
	`true` if currently net_receive block being printed More...

bool	printing_net_init = false
	`true` if currently initial block of net_receive being printed More...

bool	printing_top_verbatim_blocks = false
	`true` if currently printing top level verbatim blocks More...

bool	internal_method_call_encountered = false
	`true` if internal method call was encountered while processing verbatim block More...

int	current_watch_statement = 0
	Index of watch statement being printed. More...

std::unordered_map< CppObjectSpecifier, std::string >	object_specifier_map

Detailed Description

Visitor for printing C++ code compatible with legacy api of CoreNEURON

Todo:

Handle define statement (i.e. macros)
If there is a return statement in the verbatim block of inlined function then it will be error. Need better error checking. For example, see netstim.mod where we have removed return from verbatim block.

Definition at line 62 of file codegen_coreneuron_cpp_visitor.hpp.

Member Function Documentation

◆ add_variable_point_process()

void nmodl::codegen::CodegenCoreneuronCppVisitor::add_variable_point_process ( std::vector< IndexVariableInfo > & variables )

overrideprotectedvirtual

Add the variable point_process during get_int_variables.

note that this variable is not printed in neuron implementation

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 427 of file codegen_coreneuron_cpp_visitor.cpp.

◆ add_variable_tqitem()

void nmodl::codegen::CodegenCoreneuronCppVisitor::add_variable_tqitem ( std::vector< IndexVariableInfo > & variables )

overrideprotectedvirtual

Add the variable tqitem during get_int_variables.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 413 of file codegen_coreneuron_cpp_visitor.cpp.

◆ append_conc_write_statements()

void nmodl::codegen::CodegenCoreneuronCppVisitor::append_conc_write_statements	(	std::vector< ShadowUseStatement > &	statements,
		const Ion &	ion,
		const std::string &	concentration
	)

overrideprotectedvirtual

Generate Function call statement for nrn_wrote_conc.

Parameters

statements	Statements are appended to this vector.
ion	The ion variable.
concentration	The name of the concentration variable

Returns: The string representing the function call

Todo:: Unhandled case in neuron implementation

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 583 of file codegen_coreneuron_cpp_visitor.cpp.

◆ backend_name()

std::string nmodl::codegen::CodegenCoreneuronCppVisitor::backend_name ( ) const

overrideprotectedvirtual

Name of the code generation backend.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 53 of file codegen_coreneuron_cpp_visitor.cpp.

◆ CodegenCppVisitor() [1/2]

nmodl::codegen::CodegenCppVisitor::CodegenCppVisitor

inline

Definition at line 269 of file codegen_cpp_visitor.hpp.

◆ CodegenCppVisitor() [2/2]

nmodl::codegen::CodegenCppVisitor::CodegenCppVisitor

inline

Constructs the C++ code generator visitor.

This constructor instantiates an NMODL C++ code generator and allows writing generated code into an output stream.

Note: No code generation is performed at this stage. Since the code generator classes are all based on AstVisitor the AST must be visited using e.g. visit_program in order to generate the C++ code corresponding to the AST.

Parameters

mod_filename	The name of the model for which code should be generated. It is used for constructing an output filename.
stream	The output stream onto which to write the generated code
float_type	The float type to use in the generated code. The string will be used as-is in the target code. This defaults to `double`.

Definition at line 259 of file codegen_cpp_visitor.hpp.

◆ external_method_arguments()

const std::string nmodl::codegen::CodegenCoreneuronCppVisitor::external_method_arguments ( )

overrideprotectedvirtualnoexcept

Arguments for external functions called from generated code.

Returns: A string representing the arguments passed to an external function

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 463 of file codegen_coreneuron_cpp_visitor.cpp.

◆ external_method_parameters()

const CodegenCppVisitor::ParamVector nmodl::codegen::CodegenCoreneuronCppVisitor::external_method_parameters ( bool table = false )

overrideprotectedvirtualnoexcept

Parameters for functions in generated code that are called back from external code.

Functions registered in NEURON during initialization for callback must adhere to a prescribed calling convention. This method generates the string representing the function parameters for these externally called functions.

Parameters

table

Returns: A ParamVector representing the parameters of the function

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 468 of file codegen_coreneuron_cpp_visitor.cpp.

◆ float_variable_name()

std::string nmodl::codegen::CodegenCoreneuronCppVisitor::float_variable_name	(	const SymbolType &	symbol,
		bool	use_instance
	)		const

overrideprotectedvirtual

Determine the name of a float variable given its symbol.

This function typically returns the accessor expression in backend code for the given symbol. Since the model variables are stored in data arrays and accessed by offset, this function will return the C++ string representing the array access at the correct offset

Parameters

symbol	The symbol of a variable for which we want to obtain its name
use_instance	Should the variable be accessed via instance or data array

Returns: The backend code string representing the access to the given variable symbol

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 753 of file codegen_coreneuron_cpp_visitor.cpp.

◆ function_table_parameters()

std::pair< CodegenCoreneuronCppVisitor::ParamVector, CodegenCoreneuronCppVisitor::ParamVector > nmodl::codegen::CodegenCoreneuronCppVisitor::function_table_parameters ( const ast::FunctionTableBlock & node )

overrideprotectedvirtual

Parameters of the function itself "{}" and "table_{}".

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 503 of file codegen_coreneuron_cpp_visitor.cpp.

◆ functor_params()

CodegenCppVisitor::ParamVector nmodl::codegen::CodegenCoreneuronCppVisitor::functor_params ( )

overrideprotectedvirtual

The parameters of the Newton solver "functor".

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 981 of file codegen_coreneuron_cpp_visitor.cpp.

◆ get_range_var_float_type()

std::string nmodl::codegen::CodegenCoreneuronCppVisitor::get_range_var_float_type ( const SymbolType & symbol )

protected

Returns floating point type for given range variable symbol.

Parameters

symbol A range variable symbol

If floating point type like "float" is specified on command line then we can't turn all variables to new type. This is because certain variables are pointers to internal variables (e.g. ions). Hence, we check if given variable can be safely converted to new type. If so, return new type.

Definition at line 1581 of file codegen_coreneuron_cpp_visitor.cpp.

◆ get_variable_name()

std::string nmodl::codegen::CodegenCoreneuronCppVisitor::get_variable_name	(	const std::string &	name,
		bool	use_instance = `true`
	)		const

overrideprotectedvirtual

Determine variable name in the structure of mechanism properties.

Parameters

name	Variable name that is being printed
use_instance	Should the variable be accessed via instance or data array

Returns: The C++ string representing the access to the variable in the neuron thread structure

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 807 of file codegen_coreneuron_cpp_visitor.cpp.

◆ global_variable_name()

std::string nmodl::codegen::CodegenCoreneuronCppVisitor::global_variable_name	(	const SymbolType &	symbol,
		bool	use_instance = `true`
	)		const

overrideprotectedvirtual

Determine the variable name for a global variable given its symbol.

Parameters

symbol	The symbol of a variable for which we want to obtain its name
use_instance	Should the variable be accessed via the (host-only) global variable or the instance-specific copy (also available on GPU).

Returns: The C++ string representing the access to the global variable

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 797 of file codegen_coreneuron_cpp_visitor.cpp.

◆ int_variable_name()

std::string nmodl::codegen::CodegenCoreneuronCppVisitor::int_variable_name	(	const IndexVariableInfo &	symbol,
		const std::string &	name,
		bool	use_instance
	)		const

overrideprotectedvirtual

Determine the name of an int variable given its symbol.

This function typically returns the accessor expression in backend code for the given symbol. Since the model variables are stored in data arrays and accessed by offset, this function will return the C++ string representing the array access at the correct offset

Parameters

symbol	The symbol of a variable for which we want to obtain its name
name	The name of the index variable
use_instance	Should the variable be accessed via instance or data array

Returns: The backend code string representing the access to the given variable symbol

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 771 of file codegen_coreneuron_cpp_visitor.cpp.

◆ internal_method_arguments()

std::string nmodl::codegen::CodegenCoreneuronCppVisitor::internal_method_arguments ( )

overrideprotectedvirtual

Arguments for functions that are defined and used internally.

Returns: the method arguments

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 438 of file codegen_coreneuron_cpp_visitor.cpp.

◆ internal_method_parameters()

CodegenCoreneuronCppVisitor::ParamVector nmodl::codegen::CodegenCoreneuronCppVisitor::internal_method_parameters ( )

overrideprotectedvirtual

Parameters for internally defined functions.

Returns: the method parameters

Todo:: : figure out how to correctly handle qualifiers

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 446 of file codegen_coreneuron_cpp_visitor.cpp.

◆ is_constant_variable()

bool nmodl::codegen::CodegenCoreneuronCppVisitor::is_constant_variable ( const std::string & name ) const

protectedvirtual

Check if variable is qualified as constant.

Parameters

name	The name of variable

Returns: true if it is constant

This can be override in the backend. For example, parameters can be constant except in INITIAL block where they are set to 0. As initial block is/can be executed on c++/cpu backend, gpu backend can mark the parameter as constant.

Definition at line 142 of file codegen_coreneuron_cpp_visitor.cpp.

◆ namespace_name()

std::string nmodl::codegen::CodegenCoreneuronCppVisitor::namespace_name ( )

overrideprotectedvirtual

Name of "our" namespace.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 689 of file codegen_coreneuron_cpp_visitor.cpp.

◆ needs_v_unused()

bool nmodl::codegen::CodegenCoreneuronCppVisitor::needs_v_unused ( ) const

overrideprotectedvirtual

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 62 of file codegen_coreneuron_cpp_visitor.cpp.

◆ net_receive_buffering_declaration()

std::string nmodl::codegen::CodegenCoreneuronCppVisitor::net_receive_buffering_declaration ( )

protectedvirtual

Generate the target backend code for the net_receive_buffering function delcaration.

Returns: The target code string

Definition at line 2332 of file codegen_coreneuron_cpp_visitor.cpp.

◆ nrn_cur_reduction_loop_required()

bool nmodl::codegen::CodegenCoreneuronCppVisitor::nrn_cur_reduction_loop_required ( )

protectedvirtual

Check if reduction block in nrn_cur required.

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 236 of file codegen_coreneuron_cpp_visitor.cpp.

◆ nrn_thread_arguments()

std::string nmodl::codegen::CodegenCoreneuronCppVisitor::nrn_thread_arguments ( ) const

overrideprotectedvirtual

Arguments for "_threadargs_" macro in neuron implementation.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 486 of file codegen_coreneuron_cpp_visitor.cpp.

◆ nrn_thread_internal_arguments()

std::string nmodl::codegen::CodegenCoreneuronCppVisitor::nrn_thread_internal_arguments ( )

overrideprotectedvirtual

Arguments for "_threadargs_" macro in neuron implementation.

Function call arguments when function or procedure is defined in the same mod file itself.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 498 of file codegen_coreneuron_cpp_visitor.cpp.

◆ num_thread_objects()

int nmodl::codegen::CodegenCoreneuronCppVisitor::num_thread_objects ( ) const

inlineprotectednoexcept

Determine the number of threads to allocate.

Definition at line 92 of file codegen_coreneuron_cpp_visitor.hpp.

◆ optimize_ion_variable_copies()

bool nmodl::codegen::CodegenCoreneuronCppVisitor::optimize_ion_variable_copies ( ) const

overrideprotectedvirtual

Check if ion variable copies should be avoided.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 293 of file codegen_coreneuron_cpp_visitor.cpp.

◆ position_of_float_var()

int nmodl::codegen::CodegenCoreneuronCppVisitor::position_of_float_var ( const std::string & name ) const

overrideprotectedvirtual

Determine the position in the data array for a given float variable.

Parameters

name	The name of a float variable

Returns: The position index in the data array

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 71 of file codegen_coreneuron_cpp_visitor.cpp.

◆ position_of_int_var()

int nmodl::codegen::CodegenCoreneuronCppVisitor::position_of_int_var ( const std::string & name ) const

overrideprotectedvirtual

Determine the position in the data array for a given int variable.

Parameters

name	The name of an int variable

Returns: The position index in the data array

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 76 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_abort_routine()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_abort_routine ( ) const

protectedvirtual

Print backend specific abort routine.

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 316 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_atomic_reduction_pragma()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_atomic_reduction_pragma ( )

protectedvirtual

Print atomic update pragma for reduction statements.

In the current implementation of CPU/CPP backend we need to emit atomic pragma only with PROTECT construct (atomic rduction requirement for other cases on CPU is handled via separate shadow vectors).

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 278 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_backend_includes()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_backend_includes ( )

protectedvirtual

Print backend specific includes (none needed for C++ backend)

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 288 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_before_after_block()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_before_after_block	(	const ast::Block *	node,
		size_t	block_id
	)

protectedvirtual

Print NMODL before / after block in target backend code.

Parameters

node	AST node of type before/after type being printed
block_id	Index of the before/after block

name of the before/after function

print common function code like init/state/current

print main body

loop end including data annotation block

Definition at line 1882 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_check_table_thread_function()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_check_table_thread_function ( )

protected

Print check_table functions.

Definition at line 348 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_codegen_routines()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_codegen_routines ( )

overrideprotectedvirtual

Print entry point to code generation.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 2965 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_common_getters()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_common_getters ( )

protected

Print common getters.

Definition at line 2895 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_compute_functions()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_compute_functions ( )

overrideprotectedvirtual

Print all compute functions for every backend.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 2934 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_coreneuron_includes()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_coreneuron_includes ( )

protected

Print includes from coreneuron.

Definition at line 897 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_data_structures()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_data_structures ( bool print_initializers )

overrideprotectedvirtual

Print all classes.

Parameters

print_initializers Whether to include default values.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 2906 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_deriv_advance_flag_transfer_to_device()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_deriv_advance_flag_transfer_to_device ( ) const

protectedvirtual

Print the code to copy derivative advance flag to device.

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 167 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_derivimplicit_kernel()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_derivimplicit_kernel ( const ast::Block & block )

protected

Print derivative kernel when derivimplicit method is used.

Parameters

block The corresponding AST node representing an NMODL derivimplicit block

Todo:: Data is not derived.

Need to add instance into instance struct? data used here is wrong in AoS because as in original implementation, data is not incremented every iteration for AoS. May be better to derive actual variable names? [resolved now?] slist needs to added as local variable

Definition at line 2543 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_device_atomic_capture_annotation()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_device_atomic_capture_annotation ( ) const

protectedvirtual

Print pragma annotation for increase and capture of variable in automatic way.

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 172 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_device_stream_wait()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_device_stream_wait ( ) const

protectedvirtual

Print the code to synchronise/wait on stream specific to NrnThread.

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 197 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_dt_update_to_device()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_dt_update_to_device ( ) const

protectedvirtual

Print the code to update dt from host to device.

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 192 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_fast_imem_calculation()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_fast_imem_calculation ( )

overrideprotectedvirtual

Print fast membrane current calculation code.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 2822 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_first_pointer_var_index_getter()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_first_pointer_var_index_getter ( )

protected

Print the getter method for index position of first pointer variable.

Definition at line 629 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_first_random_var_index_getter()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_first_random_var_index_getter ( )

protected

Print the getter method for index position of first RANDOM variable.

Definition at line 637 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_function_or_procedure()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_function_or_procedure	(	const ast::Block &	node,
		const std::string &	name,
		const std::unordered_set< CppObjectSpecifier > &	specifiers = `{ CppObjectSpecifier::Inline}`
	)

overrideprotectedvirtual

Print nmodl function or procedure (common code)

Parameters

node	the AST node representing the function or procedure in NMODL
name	the name of the function or procedure
specifiers	the set of C++ specifiers to apply to the function signature

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 372 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_function_procedure_helper()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_function_procedure_helper ( const ast::Block & node )

overrideprotectedvirtual

Common helper function to help printing function or procedure blocks.

Parameters

node	the AST node representing the function or procedure in NMODL

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 395 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_function_prototypes()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_function_prototypes ( )

overrideprotectedvirtual

Print function and procedures prototype declaration.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 329 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_function_table_call()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_function_table_call ( const ast::FunctionCall & node )

overrideprotectedvirtual

Print special code when calling FUNCTION_TABLEs.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 2228 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_g_unused()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_g_unused ( ) const

overrideprotectedvirtual

Set g_unused (conductance) for NRN_PRCELLSTATE feature.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 2925 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_get_memb_list()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_get_memb_list ( )

protectedvirtual

Print the target backend code for defining and checking a local Memb_list variable.

Definition at line 2337 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_global_function_common_code()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_global_function_common_code	(	BlockType	type,
		const std::string &	function_name = `""`
	)

overrideprotectedvirtual

Print common code for global functions like nrn_init, nrn_cur and nrn_state.

Parameters

type	The target backend code block type

TODO: Remove this when the code generation is propery done Related to https://github.com/BlueBrain/nmodl/issues/692

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 1756 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_global_method_annotation()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_global_method_annotation ( )

protectedvirtual

Print backend specific global method annotation.

Note: This is not used for the C++ backend

Definition at line 283 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_global_variable_device_update_annotation()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_global_variable_device_update_annotation ( )

protectedvirtual

Print the pragma annotation to update global variables from host to the device.

Note: This is not used for the C++ backend

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 1555 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_global_variables_for_hoc()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_global_variables_for_hoc ( )

overrideprotectedvirtual

Print byte arrays that register scalar and vector variables for hoc interface.

Print structs that encapsulate information about scalar and vector elements of type global and thread variables.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 1153 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_headers_include()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_headers_include ( )

overrideprotectedvirtual

Print all includes.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 2888 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_initial_block()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_initial_block ( const ast::InitialBlock * node )

protected

Print initial block statements.

Generate the target backend code corresponding to the NMODL initial block statements

Parameters

node	The AST Node representing a NMODL initial block

Definition at line 1720 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_instance_struct_copy_to_device()

virtual void nmodl::codegen::CodegenCoreneuronCppVisitor::print_instance_struct_copy_to_device ( )

inlineprotectedvirtual

Transfer the instance struct to the device.

This calls a function declared by print_instance_struct_transfer_routine_declarations.

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 295 of file codegen_coreneuron_cpp_visitor.hpp.

◆ print_instance_struct_delete_from_device()

virtual void nmodl::codegen::CodegenCoreneuronCppVisitor::print_instance_struct_delete_from_device ( )

inlineprotectedvirtual

Delete the instance struct from the device.

This calls a function declared by print_instance_struct_transfer_routine_declarations.

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 302 of file codegen_coreneuron_cpp_visitor.hpp.

◆ print_instance_struct_transfer_routine_declarations()

virtual void nmodl::codegen::CodegenCoreneuronCppVisitor::print_instance_struct_transfer_routine_declarations ( )

inlineprotectedvirtual

Print declarations of the functions used by print_instance_struct_copy_to_device and print_instance_struct_delete_from_device.

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 273 of file codegen_coreneuron_cpp_visitor.hpp.

◆ print_instance_struct_transfer_routines()

virtual void nmodl::codegen::CodegenCoreneuronCppVisitor::print_instance_struct_transfer_routines ( std::vector< std::string > const & )

inlineprotectedvirtual

Print the definitions of the functions used by print_instance_struct_copy_to_device and print_instance_struct_delete_from_device.

Declarations of these functions are printed by print_instance_struct_transfer_routine_declarations.

This updates the (pointer) member variables in the device copy of the instance struct to contain device pointers, which is why you must pass a list of names of those member variables.

Parameters

ptr_members List of instance struct member names.

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 287 of file codegen_coreneuron_cpp_visitor.hpp.

◆ print_instance_variable_setup()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_instance_variable_setup ( )

Print the function that initialize instance structure.

Definition at line 1597 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_ion_var_constructor()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_ion_var_constructor ( const std::vector< std::string > & members )

protectedvirtual

Print constructor of ion variables.

Parameters

members The ion variable names

Definition at line 1533 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_ion_var_structure()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_ion_var_structure ( )

protected

Print structure of ion variables used for local copies.

Definition at line 1503 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_ion_variable()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_ion_variable ( )

overrideprotectedvirtual

Print the ion variable struct.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 1550 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_kernel_data_present_annotation_block_begin()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_kernel_data_present_annotation_block_begin ( )

protectedvirtual

Print accelerator annotations indicating data presence on device.

Each kernel such as nrn_init, nrn_state and nrn_cur could be offloaded to accelerator. In this case, at very top level, we print pragma for data present. For example:

void nrn_state(...) {
    #pragma acc data present (nt, ml...)
    {
 
    }
}

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 216 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_kernel_data_present_annotation_block_end()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_kernel_data_present_annotation_block_end ( )

protectedvirtual

Print matching block end of accelerator annotations for data presence on device.

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 221 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_mech_type_getter()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_mech_type_getter ( )

protected

Print the getter method for returning mechtype.

Definition at line 669 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_mechanism_global_var_structure()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_mechanism_global_var_structure ( bool print_initializers )

overrideprotectedvirtual

Print the structure that wraps all global variables used in the NMODL.

Parameters

print_initializers Whether to include default values in the struct definition (true: int foo{42}; false: int foo;)

Variables required for type of ion, type of point process etc. are of static int type. For the C++ backend type, it's ok to have these variables as file scoped static variables.

Initial values of state variables (h0) are also defined as static variables. Note that the state could be ion variable and it could be also range variable. Hence lookup into symbol table before.

When model is not vectorized (shouldn't be the case in coreneuron) the top local variables become static variables.

Note that static variables are already initialized to 0. We do the same for some variables to keep same code as neuron.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 1009 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_mechanism_range_var_structure()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_mechanism_range_var_structure ( bool print_initializers )

overridevirtual

Print the structure that wraps all range and int variables required for the NMODL.

Parameters

print_initializers Whether or not default values for variables be included in the struct declaration.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 1461 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_mechanism_register()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_mechanism_register ( )

overrideprotectedvirtual

Print the mechanism registration function.

Every mod file has register function to connect with the simulator. Various information about mechanism and callbacks get registered with the simulator using suffix_reg() function.

Here are details:

We should exclude that callback based on the solver, watch statements.
If nrn_get_mechtype is < -1 means that mechanism is not used in the context of neuron execution and hence could be ignored in coreneuron execution.
Ions are internally defined and their types can be queried similar to other mechanisms.
hoc_register_var may not be needed in the context of coreneuron
We assume net receive buffer is on. This is because generated code is compatible for cpu as well as gpu target.

register all before/after blocks

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 1260 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_memb_list_getter()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_memb_list_getter ( )

protected

Print the getter method for returning membrane list from NrnThread.

Definition at line 678 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_memory_allocation_routine()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_memory_allocation_routine ( ) const

protectedvirtual

Print memory allocation routine.

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 298 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_net_event_call()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_net_event_call ( const ast::FunctionCall & node )

overrideprotectedvirtual

Print call to net_event.

Parameters

node	The AST node representing the function call

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 2213 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_net_init()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_net_init ( )

protected

Print initial block in the net receive block.

Definition at line 2279 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_net_init_acc_serial_annotation_block_begin()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_net_init_acc_serial_annotation_block_begin ( )

protectedvirtual

Print accelerator kernels begin annotation for net_init kernel.

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 226 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_net_init_acc_serial_annotation_block_end()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_net_init_acc_serial_annotation_block_end ( )

protectedvirtual

Print accelerator kernels end annotation for net_init kernel.

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 231 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_net_move_call()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_net_move_call ( const ast::FunctionCall & node )

overrideprotectedvirtual

Print call to net_move.

Parameters

node	The AST node representing the function call

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 2186 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_net_receive()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_net_receive ( )

protected

Print net_receive function definition.

Definition at line 2502 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_net_receive_arg_size_getter()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_net_receive_arg_size_getter ( )

protected

Print the getter method for getting number of arguments for net_receive.

Definition at line 658 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_net_receive_buffering()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_net_receive_buffering ( bool need_mech_inst = true )

protected

Print kernel for buffering net_receive events.

This kernel is only needed for accelerator backends where net_receive needs to be executed in two stages as the actual communication must be done in the host code.

Parameters

need_mech_inst true if the generated code needs a local inst variable to be defined

Definition at line 2358 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_net_receive_common_code()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_net_receive_common_code	(	const ast::Block &	node,
		bool	need_mech_inst = `true`
	)

protected

Print the common code section for net receive related methods.

Parameters

node	The AST node representing the corresponding NMODL block
need_mech_inst	`true` if a local `inst` variable needs to be defined in generated code

Definition at line 2103 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_net_receive_kernel()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_net_receive_kernel ( )

protected

Print net_receive kernel function definition.

Definition at line 2443 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_net_receive_loop_begin()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_net_receive_loop_begin ( )

protectedvirtual

Print the code for the main net_receive loop.

Definition at line 2346 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_net_receive_loop_end()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_net_receive_loop_end ( )

protectedvirtual

Print the code for closing the main net_receive loop.

Definition at line 2353 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_net_send_buf_count_update_to_device()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_net_send_buf_count_update_to_device ( ) const

protectedvirtual

Print the code to update NetSendBuffer_t count from host to device.

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 187 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_net_send_buf_count_update_to_host()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_net_send_buf_count_update_to_host ( ) const

protectedvirtual

Print the code to update NetSendBuffer_t count from device to host.

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 177 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_net_send_buf_update_to_host()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_net_send_buf_update_to_host ( ) const

protectedvirtual

Print the code to update NetSendBuffer_t from device to host.

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 182 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_net_send_buffering()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_net_send_buffering ( )

protected

Print kernel for buffering net_send events.

This kernel is only needed for accelerator backends where net_send needs to be executed in two stages as the actual communication must be done in the host code.

Definition at line 2416 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_net_send_buffering_cnt_update()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_net_send_buffering_cnt_update ( ) const

protectedvirtual

Print the code related to the update of NetSendBuffer_t cnt.

For GPU this needs to be done with atomic operation, on CPU it's not needed.

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 2404 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_net_send_buffering_grow()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_net_send_buffering_grow ( )

protectedvirtual

Print statement that grows NetSendBuffering_t structure if needed.

This function should be overridden for backends that cannot dynamically reallocate the buffer

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 2409 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_net_send_call()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_net_send_call ( const ast::FunctionCall & node )

overrideprotectedvirtual

Print call to net_send.

Parameters

node	The AST node representing the function call

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 2154 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_newtonspace_transfer_to_device()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_newtonspace_transfer_to_device ( ) const

protectedvirtual

Print code block to transfer newtonspace structure to device.

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 2632 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_nrn_alloc()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_nrn_alloc ( )

overrideprotectedvirtual

Print nrn_alloc function definition.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 1960 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_nrn_constructor()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_nrn_constructor ( )

overrideprotectedvirtual

Print nrn_constructor function definition.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 1936 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_nrn_cur()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_nrn_cur ( )

overrideprotectedvirtual

Print nrn_cur / current update function definition.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 2851 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_nrn_cur_conductance_kernel()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_nrn_cur_conductance_kernel ( const ast::BreakpointBlock & node )

overrideprotectedvirtual

Print the nrn_cur kernel with NMODL conductance keyword provisions.

If the NMODL conductance keyword is used in the breakpoint block, then CodegenCoreneuronCppVisitor::print_nrn_cur_kernel will use this printer

Parameters

node	the AST node representing the NMODL breakpoint block

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 2715 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_nrn_cur_kernel()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_nrn_cur_kernel ( const ast::BreakpointBlock & node )

overrideprotectedvirtual

Print main body of nrn_cur function.

Parameters

node	the AST node representing the NMODL breakpoint block

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 2786 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_nrn_cur_matrix_shadow_reduction()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_nrn_cur_matrix_shadow_reduction ( )

protectedvirtual

Print the reduction to matrix elements from shadow vectors.

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 262 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_nrn_cur_matrix_shadow_update()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_nrn_cur_matrix_shadow_update ( )

protectedvirtual

Print the update to matrix elements with/without shadow vectors.

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 249 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_nrn_cur_non_conductance_kernel()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_nrn_cur_non_conductance_kernel ( )

overrideprotectedvirtual

Print the nrn_cur kernel without NMODL conductance keyword provisions.

If the NMODL conductance keyword is not used in the breakpoint block, then CodegenCoreneuronCppVisitor::print_nrn_cur_kernel will use this printer

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 2752 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_nrn_current()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_nrn_current ( const ast::BreakpointBlock & node )

overrideprotectedvirtual

Print the nrn_current kernel.

Note: nrn_cur_kernel will have two calls to nrn_current if no conductance keywords specified

Parameters

node	the AST node representing the NMODL breakpoint block

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 2697 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_nrn_destructor()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_nrn_destructor ( )

overrideprotectedvirtual

Print nrn_destructor function definition.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 1948 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_nrn_init()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_nrn_init ( bool skip_init_check = true )

protected

Print the nrn_init function definition.

Parameters

skip_init_check true to generate code executing the initialization conditionally

Definition at line 1807 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_nrn_state()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_nrn_state ( )

overrideprotectedvirtual

Print nrn_state / state update function definition.

Todo:: Eigen solver node also emits IonCurVar variable in the functor but that shouldn't update ions in derivative block

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 2642 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_num_variable_getter()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_num_variable_getter ( )

protected

Print the getter methods for float and integer variables count.

Definition at line 645 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_rhs_d_shadow_variables()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_rhs_d_shadow_variables ( )

protectedvirtual

Print the setup method for setting matrix shadow vectors.

Reimplemented in nmodl::codegen::CodegenAccVisitor.

Definition at line 241 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_sdlists_init()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_sdlists_init ( bool print_initializers )

overrideprotectedvirtual

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 930 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_send_event_move()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_send_event_move ( )

protected

Print send event move block used in net receive as well as watch.

Definition at line 2311 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_setup_range_variable()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_setup_range_variable ( )

protected

Print the function that initialize range variable with different data type.

Definition at line 1560 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_standard_includes()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_standard_includes ( )

overrideprotectedvirtual

Print standard C/C++ includes.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 886 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_thread_getters()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_thread_getters ( )

protected

Print the getter method for thread variables and ids.

There are three types of thread variables currently considered:

top local thread variables
thread variables in the mod file
thread variables for solver

These variables are allocated into different thread structures and have corresponding thread ids. Thread id start from 0. In mod2c implementation, thread_data_index is increased at various places and it is used to decide the index of thread.

Definition at line 704 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_thread_memory_callbacks()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_thread_memory_callbacks ( )

protected

Print thread related memory allocation and deallocation callbacks.

Definition at line 1398 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_v_unused()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_v_unused ( ) const

overrideprotectedvirtual

Set v_unused (voltage) for NRN_PRCELLSTATE feature.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 2913 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_watch_activate()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_watch_activate ( )

protected

Print watch activate function.

Todo:: Number of watch could be more than number of statements according to grammar.

Check if this is correctly handled in neuron and coreneuron.

Todo:: Similar to neuron/coreneuron we are using first watch and ignoring rest.

Definition at line 1973 of file codegen_coreneuron_cpp_visitor.cpp.

◆ print_watch_check()

void nmodl::codegen::CodegenCoreneuronCppVisitor::print_watch_check ( )

protected

Print watch activate function.

Todo:: Similar to print_watch_activate, we are using only first watch.

need to verify with neuron/coreneuron about rest.

Definition at line 2021 of file codegen_coreneuron_cpp_visitor.cpp.

◆ process_verbatim_text()

std::string nmodl::codegen::CodegenCoreneuronCppVisitor::process_verbatim_text ( std::string const & text )

protected

Process a verbatim block for possible variable renaming.

Processing commonly used constructs in the verbatim blocks.

Parameters

text	The verbatim code to be processed

Returns: The code with all variables renamed as needed

Todo:: : this is still ad-hoc and requires re-implementation to handle it more elegantly.

Definition at line 545 of file codegen_coreneuron_cpp_visitor.cpp.

◆ process_verbatim_token()

std::string nmodl::codegen::CodegenCoreneuronCppVisitor::process_verbatim_token ( const std::string & token )

protected

Process a token in a verbatim block for possible variable renaming.

Parameters

token The verbatim token to be processed

Returns: The code after variable renaming

Often top level verbatim blocks use variables with old names. Here we process if we are processing verbatim block at global scope.

Definition at line 85 of file codegen_coreneuron_cpp_visitor.cpp.

◆ register_mechanism_arguments()

std::string nmodl::codegen::CodegenCoreneuronCppVisitor::register_mechanism_arguments ( ) const

overrideprotectedvirtual

Arguments for register_mech or point_register_mech function.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 564 of file codegen_coreneuron_cpp_visitor.cpp.

◆ replace_if_verbatim_variable()

std::string nmodl::codegen::CodegenCoreneuronCppVisitor::replace_if_verbatim_variable ( std::string name )

protected

Replace commonly used verbatim variables.

Replace commonly used variables in the verbatim blocks into their corresponding variable name in the new code generation backend.

Parameters

name	A variable name to be checked and possibly updated

Returns: The possibly replace variable name

if function is defined the same mod file then the arguments must contain mechanism instance as well.

Definition at line 516 of file codegen_coreneuron_cpp_visitor.cpp.

◆ simulator_name()

std::string nmodl::codegen::CodegenCoreneuronCppVisitor::simulator_name ( )

overrideprotectedvirtual

Name of the simulator the code was generated for.

Implements nmodl::codegen::CodegenCppVisitor.

Definition at line 58 of file codegen_coreneuron_cpp_visitor.cpp.

◆ visit_derivimplicit_callback()

void nmodl::codegen::CodegenCoreneuronCppVisitor::visit_derivimplicit_callback ( const ast::DerivimplicitCallback & node )

overrideprotectedvirtual

visit node of type ast::DerivimplicitCallback

Implements nmodl::visitor::ConstVisitor.

Definition at line 2996 of file codegen_coreneuron_cpp_visitor.cpp.

◆ visit_for_netcon()

void nmodl::codegen::CodegenCoreneuronCppVisitor::visit_for_netcon ( const ast::ForNetcon & node )

overrideprotectedvirtual

visit node of type ast::ForNetcon

Implements nmodl::visitor::ConstVisitor.

Definition at line 3004 of file codegen_coreneuron_cpp_visitor.cpp.

◆ visit_protect_statement()

void nmodl::codegen::CodegenCoreneuronCppVisitor::visit_protect_statement ( const ast::ProtectStatement & node )

overrideprotectedvirtual

visit node of type ast::ProtectStatement

Implements nmodl::visitor::ConstVisitor.

Definition at line 3042 of file codegen_coreneuron_cpp_visitor.cpp.

◆ visit_verbatim()

void nmodl::codegen::CodegenCoreneuronCppVisitor::visit_verbatim ( const ast::Verbatim & node )

overrideprotectedvirtual

visit node of type ast::Verbatim

Implements nmodl::visitor::ConstVisitor.

Definition at line 121 of file codegen_coreneuron_cpp_visitor.cpp.

◆ visit_watch_statement()

void nmodl::codegen::CodegenCoreneuronCppVisitor::visit_watch_statement ( const ast::WatchStatement & node )

overrideprotectedvirtual

visit node of type ast::WatchStatement

Implements nmodl::visitor::ConstVisitor.

Definition at line 3036 of file codegen_coreneuron_cpp_visitor.cpp.

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

/home/docs/checkouts/readthedocs.org/user_builds/nrn/checkouts/latest/src/nmodl/codegen/codegen_coreneuron_cpp_visitor.hpp
/home/docs/checkouts/readthedocs.org/user_builds/nrn/checkouts/latest/src/nmodl/codegen/codegen_coreneuron_cpp_visitor.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ add_variable_point_process()

◆ add_variable_tqitem()

◆ append_conc_write_statements()

◆ backend_name()

◆ CodegenCppVisitor() [1/2]

◆ CodegenCppVisitor() [2/2]

◆ external_method_arguments()

◆ external_method_parameters()

◆ float_variable_name()

◆ function_table_parameters()

◆ functor_params()

◆ get_range_var_float_type()

◆ get_variable_name()

◆ global_variable_name()

◆ int_variable_name()

◆ internal_method_arguments()

◆ internal_method_parameters()

◆ is_constant_variable()

◆ namespace_name()

◆ needs_v_unused()

◆ net_receive_buffering_declaration()

◆ nrn_cur_reduction_loop_required()

◆ nrn_thread_arguments()

◆ nrn_thread_internal_arguments()

◆ num_thread_objects()

◆ optimize_ion_variable_copies()

◆ position_of_float_var()

◆ position_of_int_var()

◆ print_abort_routine()

◆ print_atomic_reduction_pragma()

◆ print_backend_includes()

◆ print_before_after_block()

◆ print_check_table_thread_function()

◆ print_codegen_routines()

◆ print_common_getters()

◆ print_compute_functions()

◆ print_coreneuron_includes()

◆ print_data_structures()

◆ print_deriv_advance_flag_transfer_to_device()

◆ print_derivimplicit_kernel()

◆ print_device_atomic_capture_annotation()

◆ print_device_stream_wait()

◆ print_dt_update_to_device()

◆ print_fast_imem_calculation()

◆ print_first_pointer_var_index_getter()

◆ print_first_random_var_index_getter()

◆ print_function_or_procedure()

◆ print_function_procedure_helper()

◆ print_function_prototypes()

◆ print_function_table_call()

◆ print_g_unused()

◆ print_get_memb_list()

◆ print_global_function_common_code()

◆ print_global_method_annotation()

◆ print_global_variable_device_update_annotation()

◆ print_global_variables_for_hoc()

◆ print_headers_include()

◆ print_initial_block()

◆ print_instance_struct_copy_to_device()

◆ print_instance_struct_delete_from_device()

◆ print_instance_struct_transfer_routine_declarations()

◆ print_instance_struct_transfer_routines()

◆ print_instance_variable_setup()

◆ print_ion_var_constructor()

◆ print_ion_var_structure()

◆ print_ion_variable()

◆ print_kernel_data_present_annotation_block_begin()

◆ print_kernel_data_present_annotation_block_end()

◆ print_mech_type_getter()

◆ print_mechanism_global_var_structure()

◆ print_mechanism_range_var_structure()

◆ print_mechanism_register()

◆ print_memb_list_getter()

◆ print_memory_allocation_routine()

◆ print_net_event_call()