File: steadystate.cpp

package info (click to toggle)
nmodl 0.5-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 5,308 kB
  • sloc: cpp: 27,777; javascript: 9,841; yacc: 2,815; python: 1,962; lex: 1,674; xml: 181; sh: 136; ansic: 37; makefile: 18; pascal: 7
file content (178 lines) | stat: -rw-r--r-- 6,476 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
/*************************************************************************
 * Copyright (C) 2018-2022 Blue Brain Project
 *
 * This file is part of NMODL distributed under the terms of the GNU
 * Lesser General Public License. See top-level LICENSE file for details.
 *************************************************************************/

#include <catch2/catch.hpp>

#include "ast/program.hpp"
#include "parser/nmodl_driver.hpp"
#include "test/unit/utils/test_utils.hpp"
#include "visitors/checkparent_visitor.hpp"
#include "visitors/constant_folder_visitor.hpp"
#include "visitors/kinetic_block_visitor.hpp"
#include "visitors/loop_unroll_visitor.hpp"
#include "visitors/steadystate_visitor.hpp"
#include "visitors/symtab_visitor.hpp"
#include "visitors/visitor_utils.hpp"

using namespace nmodl;
using namespace visitor;
using namespace test;
using namespace test_utils;

using ast::AstNodeType;
using nmodl::parser::NmodlDriver;


//=============================================================================
// STEADYSTATE visitor tests
//=============================================================================

std::vector<std::string> run_steadystate_visitor(
    const std::string& text,
    const std::vector<AstNodeType>& ret_nodetypes = {AstNodeType::SOLVE_BLOCK,
                                                     AstNodeType::DERIVATIVE_BLOCK}) {
    std::vector<std::string> results;
    // construct AST from text
    NmodlDriver driver;
    const auto& ast = driver.parse_string(text);

    // construct symbol table from AST
    SymtabVisitor().visit_program(*ast);

    // unroll loops and fold constants
    ConstantFolderVisitor().visit_program(*ast);
    LoopUnrollVisitor().visit_program(*ast);
    ConstantFolderVisitor().visit_program(*ast);
    SymtabVisitor().visit_program(*ast);

    // Run kinetic block visitor first, so any kinetic blocks
    // are converted into derivative blocks
    KineticBlockVisitor().visit_program(*ast);
    SymtabVisitor().visit_program(*ast);

    // run SteadystateVisitor on AST
    SteadystateVisitor().visit_program(*ast);

    // run lookup visitor to extract results from AST
    const auto& res = collect_nodes(*ast, ret_nodetypes);
    results.reserve(res.size());
    for (const auto& r: res) {
        results.push_back(to_nmodl(r));
    }

    // check that, after visitor rearrangement, parents are still up-to-date
    CheckParentVisitor().check_ast(*ast);

    return results;
}

SCENARIO("Solving ODEs with STEADYSTATE solve method", "[visitor][steadystate]") {
    GIVEN("STEADYSTATE sparse solve") {
        std::string nmodl_text = R"(
            BREAKPOINT  {
                SOLVE states STEADYSTATE sparse
            }
            DERIVATIVE states {
                m' = m + h
            }
        )";
        std::string expected_text1 = R"(
            DERIVATIVE states {
                m' = m+h
            })";
        std::string expected_text2 = R"(
            DERIVATIVE states_steadystate {
                dt = 1000000000
                m' = m+h
            })";
        THEN("Construct DERIVATIVE block with steadystate solution & update SOLVE statement") {
            auto result = run_steadystate_visitor(nmodl_text);
            REQUIRE(result.size() == 3);
            REQUIRE(result[0] == "SOLVE states_steadystate METHOD sparse");
            REQUIRE(reindent_text(result[1]) == reindent_text(expected_text1));
            REQUIRE(reindent_text(result[2]) == reindent_text(expected_text2));
        }
    }
    GIVEN("STEADYSTATE derivimplicit solve") {
        std::string nmodl_text = R"(
            BREAKPOINT  {
                SOLVE states STEADYSTATE derivimplicit
            }
            DERIVATIVE states {
                m' = m + h
            }
        )";
        std::string expected_text1 = R"(
            DERIVATIVE states {
                m' = m+h
            })";
        std::string expected_text2 = R"(
            DERIVATIVE states_steadystate {
                dt = 1e-09
                m' = m+h
            })";
        THEN("Construct DERIVATIVE block with steadystate solution & update SOLVE statement") {
            auto result = run_steadystate_visitor(nmodl_text);
            REQUIRE(result.size() == 3);
            REQUIRE(result[0] == "SOLVE states_steadystate METHOD derivimplicit");
            REQUIRE(reindent_text(result[1]) == reindent_text(expected_text1));
            REQUIRE(reindent_text(result[2]) == reindent_text(expected_text2));
        }
    }
    GIVEN("two STEADYSTATE solves") {
        std::string nmodl_text = R"(
            STATE {
                Z[3]
                x
            }
            BREAKPOINT  {
                SOLVE states0 STEADYSTATE derivimplicit
                SOLVE states1 STEADYSTATE sparse
            }
            DERIVATIVE states0 {
                Z'[0] = Z[1] - Z[2]
                Z'[1] = Z[0] + 2*Z[2]
                Z'[2] = Z[0]*Z[0] - 3.10
            }
            DERIVATIVE states1 {
                x' = x + c
            }
        )";
        std::string expected_text1 = R"(
            DERIVATIVE states0 {
                Z'[0] = Z[1]-Z[2]
                Z'[1] = Z[0]+2*Z[2]
                Z'[2] = Z[0]*Z[0]-3.10
            })";
        std::string expected_text2 = R"(
            DERIVATIVE states1 {
                x' = x+c
            })";
        std::string expected_text3 = R"(
            DERIVATIVE states0_steadystate {
                dt = 1e-09
                Z'[0] = Z[1]-Z[2]
                Z'[1] = Z[0]+2*Z[2]
                Z'[2] = Z[0]*Z[0]-3.10
            })";
        std::string expected_text4 = R"(
            DERIVATIVE states1_steadystate {
                dt = 1000000000
                x' = x+c
            })";
        THEN("Construct DERIVATIVE blocks with steadystate solution & update SOLVE statements") {
            auto result = run_steadystate_visitor(nmodl_text);
            REQUIRE(result.size() == 6);
            REQUIRE(result[0] == "SOLVE states0_steadystate METHOD derivimplicit");
            REQUIRE(result[1] == "SOLVE states1_steadystate METHOD sparse");
            REQUIRE(reindent_text(result[2]) == reindent_text(expected_text1));
            REQUIRE(reindent_text(result[3]) == reindent_text(expected_text2));
            REQUIRE(reindent_text(result[4]) == reindent_text(expected_text3));
            REQUIRE(reindent_text(result[5]) == reindent_text(expected_text4));
        }
    }
}