steadystate_visitor.hpp

Go to the documentation of this file.

/*
 * Copyright 2023 Blue Brain Project, EPFL.
 * See the top-level LICENSE file for details.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#pragma once
 
/**
 * \file
 * \brief \copybrief nmodl::visitor::SteadystateVisitor
 */
 
#include "visitors/ast_visitor.hpp"
 
namespace nmodl {
namespace visitor {
 
/**
 * @addtogroup visitor_classes
 * @{
 */
 
/**
 * \class SteadystateVisitor
 * \brief %Visitor for STEADYSTATE solve statements
 *
 * For each `STEADYSTATE` solve statement, creates a clone of the corresponding
 * DERIVATIVE block, with `_steadystate` appended to the name of the block. If
 * the original `DERIVATIVE` block was called `X`, the new `DERIVATIVE` block will
 * be called `X_steadystate`. Only difference in new block is that the value of `dt`
 * is changed for the solve, to:
 *   - dt = 1e9 for sparse
 *   - dt = 1e-9 for derivimplicit
 *
 * where these values for `dt` in the steady state solves are taken from NEURON see
 * https://github.com/neuronsimulator/nrn/blob/master/src/scopmath/ssimplic_thread.c
 *
 * Also updates the solve statement to point to the new `DERIVATIVE` block as a
 * `METHOD solve`, not a `STEADYSTATE` one, e.g.
 *
 * \code{.mod}
 *      SOLVE X STEADYSTATE derivimplicit
 * \endcode
 *
 * becomes
 *
 * \code{.mod}
 *      SOLVE X_steadystate METHOD derivimplicit
 * \endcode
 */
class SteadystateVisitor: public AstVisitor {
  private:
    /// create new steady state derivative block for given solve block
    std::shared_ptr<ast::DerivativeBlock> create_steadystate_block(
        const std::shared_ptr<ast::SolveBlock>& solve_block,
        const std::vector<std::shared_ptr<ast::Ast>>& deriv_blocks);
 
    const double STEADYSTATE_SPARSE_DT = 1e9;
 
    const double STEADYSTATE_DERIVIMPLICIT_DT = 1e-9;
 
  public:
    SteadystateVisitor() = default;
 
    void visit_program(ast::Program& node) override;
};
 
/** @} */  // end of visitor_classes
 
}  // namespace visitor
}  // namespace nmodl