summaryrefslogtreecommitdiffstatshomepage
path: root/src/lib/netlist/solver/nld_solver.cpp
blob: 4b24e003d52e74de31bab7ff359860fb2102669d (plain) (blame)
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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
// license:GPL-2.0+
// copyright-holders:Couriersud

// Commented out for now. Relatively low number of terminals / nets make
// the vectorizations fast-math enables pretty expensive
//
#if 0
#pragma GCC optimize "-ftree-vectorize"
#pragma GCC optimize "-ffast-math"
#pragma GCC optimize "-funsafe-math-optimizations"
#pragma GCC optimize "-funroll-loops"
#pragma GCC optimize "-funswitch-loops"
#pragma GCC optimize "-fstrict-aliasing"
#pragma GCC optimize "tree-vectorizer-verbose=7"
#pragma GCC optimize "opt-info-vec"
#pragma GCC optimize "opt-info-vec-missed"
//#pragma GCC optimize "tree-parallelize-loops=4"
#pragma GCC optimize "variable-expansion-in-unroller"
#pragma GCC optimize "unsafe-loop-optimizations"
#pragma GCC optimize "vect-cost-model"
#pragma GCC optimize "variable-expansion-in-unroller"
#pragma GCC optimize "tree-loop-if-convert-stores"
#pragma GCC optimize "tree-loop-distribution"
#pragma GCC optimize "tree-loop-im"
#pragma GCC optimize "tree-loop-ivcanon"
#pragma GCC optimize "ivopts"
#endif

#include "netlist/nl_factory.h"
#include "nld_matrix_solver.h"
#include "nld_ms_direct.h"
#include "nld_ms_direct1.h"
#include "nld_ms_direct2.h"
#include "nld_ms_gcr.h"
#include "nld_ms_gmres.h"
#include "nld_ms_sm.h"
#include "nld_ms_sor.h"
#include "nld_ms_sor_mat.h"
#include "nld_ms_w.h"
#include "nld_solver.h"
#include "plib/pomp.h"

#include <algorithm>

namespace netlist
{
namespace devices
{

	// ----------------------------------------------------------------------------------------
	// solver
	// ----------------------------------------------------------------------------------------

	NETLIB_RESET(solver)
	{
		for (auto &s : m_mat_solvers)
			s->reset();
	}

	void NETLIB_NAME(solver)::stop()
	{
		for (auto &s : m_mat_solvers)
			s->log_stats();
	}

	NETLIB_UPDATE(solver)
	{
		if (m_params.m_dynamic_ts)
			return;

		netlist_time now(exec().time());
		// force solving during start up if there are no time-step devices
		// FIXME: Needs a more elegant solution
		bool force_solve = (now < netlist_time::from_fp<decltype(m_params.m_max_timestep)>(2 * m_params.m_max_timestep));

		std::size_t nthreads = std::min(static_cast<std::size_t>(m_params.m_parallel()), plib::omp::get_max_threads());

		std::vector<solver::matrix_solver_t *> &solvers = (force_solve ? m_mat_solvers_all : m_mat_solvers_timestepping);

		if (nthreads > 1 && solvers.size() > 1)
		{
			plib::omp::set_num_threads(nthreads);
			plib::omp::for_static(static_cast<std::size_t>(0), solvers.size(), [&solvers, now](std::size_t i)
				{
					const netlist_time ts = solvers[i]->solve(now);
					plib::unused_var(ts);
				});
		}
		else
			for (auto & solver : solvers)
			{
				const netlist_time ts = solver->solve(now);
				plib::unused_var(ts);
			}

		for (auto & solver : solvers)
			solver->update_inputs();

		// step circuit
		if (!m_Q_step.net().is_queued())
		{
			m_Q_step.net().toggle_and_push_to_queue(netlist_time::from_fp(m_params.m_max_timestep));
		}
	}

	template <class C>
	plib::unique_ptr<solver::matrix_solver_t> create_it(netlist_state_t &nl, pstring name,
		analog_net_t::list_t &nets,
		solver::solver_parameters_t &params, std::size_t size)
	{
		return plib::make_unique<C>(nl, name, nets, &params, size);
	}

	template <typename FT, int SIZE>
	plib::unique_ptr<solver::matrix_solver_t> NETLIB_NAME(solver)::create_solver(std::size_t size,
		const pstring &solvername,
		analog_net_t::list_t &nets)
	{
		switch (m_params.m_method())
		{
			case solver::matrix_type_e::MAT_CR:
				if (size > 0) // GCR always outperforms MAT solver
				{
					return create_it<solver::matrix_solver_GCR_t<FT, SIZE>>(state(), solvername, nets, m_params, size);
				}
				else
				{
					return create_it<solver::matrix_solver_direct_t<FT, SIZE>>(state(), solvername, nets, m_params, size);
				}
			case solver::matrix_type_e::SOR_MAT:
				return create_it<solver::matrix_solver_SOR_mat_t<FT, SIZE>>(state(), solvername, nets, m_params, size);
			case solver::matrix_type_e::MAT:
				return create_it<solver::matrix_solver_direct_t<FT, SIZE>>(state(), solvername, nets, m_params, size);
			case solver::matrix_type_e::SM:
				// Sherman-Morrison Formula
				return create_it<solver::matrix_solver_sm_t<FT, SIZE>>(state(), solvername, nets, m_params, size);
			case solver::matrix_type_e::W:
				// Woodbury Formula
				return create_it<solver::matrix_solver_w_t<FT, SIZE>>(state(), solvername, nets, m_params, size);
			case solver::matrix_type_e::SOR:
				return create_it<solver::matrix_solver_SOR_t<FT, SIZE>>(state(), solvername, nets, m_params, size);
			case solver::matrix_type_e::GMRES:
				return create_it<solver::matrix_solver_GMRES_t<FT, SIZE>>(state(), solvername, nets, m_params, size);
		}
		return plib::unique_ptr<solver::matrix_solver_t>();
	}

	template <typename FT>
	plib::unique_ptr<solver::matrix_solver_t> NETLIB_NAME(solver)::create_solvers(
		const pstring &sname,
		analog_net_t::list_t &nets)
	{
		std::size_t net_count = nets.size();
		switch (net_count)
		{
			case 1:
				return plib::make_unique<solver::matrix_solver_direct1_t<FT>>(state(), sname, nets, &m_params);
				break;
			case 2:
				return plib::make_unique<solver::matrix_solver_direct2_t<FT>>(state(), sname, nets, &m_params);
				break;
#if 1
			case 3:
				return create_solver<FT, 3>(3, sname, nets);
				break;
			case 4:
				return create_solver<FT, 4>(4, sname, nets);
				break;
			case 5:
				return create_solver<FT, 5>(5, sname, nets);
				break;
			case 6:
				return create_solver<FT, 6>(6, sname, nets);
				break;
			case 7:
				return create_solver<FT, 7>(7, sname, nets);
				break;
			case 8:
				return create_solver<FT, 8>(8, sname, nets);
				break;
			case 9:
				return create_solver<FT, 9>(9, sname, nets);
				break;
			case 10:
				return create_solver<FT, 10>(10, sname, nets);
				break;
#if 0
			case 11:
				return create_solver<FT, 11>(11, sname);
				break;
			case 12:
				return create_solver<FT, 12>(12, sname);
				break;
			case 15:
				return create_solver<FT, 15>(15, sname);
				break;
			case 31:
				return create_solver<FT, 31>(31, sname);
				break;
			case 35:
				return create_solver<FT, 35>(35, sname);
				break;
			case 43:
				return create_solver<FT, 43>(43, sname);
				break;
			case 49:
				return create_solver<FT, 49>(49, sname);
				break;
			case 87:
				return create_solver<FT,86>(86, sname, nets);
				break;
#endif
#endif
			default:
				log().info(MI_NO_SPECIFIC_SOLVER(net_count));
				if (net_count <= 8)
				{
					return create_solver<FT, -8>(net_count, sname, nets);
				}
				else if (net_count <= 16)
				{
					return create_solver<FT, -16>(net_count, sname, nets);
				}
				else if (net_count <= 32)
				{
					return create_solver<FT, -32>(net_count, sname, nets);
				}
				else if (net_count <= 64)
				{
					return create_solver<FT, -64>(net_count, sname, nets);
				}
				else if (net_count <= 128)
				{
					return create_solver<FT, -128>(net_count, sname, nets);
				}
				else if (net_count <= 256)
				{
					return create_solver<FT, -256>(net_count, sname, nets);
				}
				else if (net_count <= 512)
				{
					return create_solver<FT, -512>(net_count, sname, nets);
				}
				else
				{
					return create_solver<FT, 0>(net_count, sname, nets);
				}
				break;
		}
	}

	struct net_splitter
	{

		bool already_processed(const analog_net_t &n) const
		{
			// no need to process rail nets - these are known variables
			if (n.isRailNet())
				return true;
			// if it's already processed - no need to continue
			for (auto & grp : groups)
				if (plib::container::contains(grp, &n))
					return true;
			return false;
		}

		void process_net(analog_net_t &n)
		{
			// ignore empty nets. FIXME: print a warning message
			if (n.num_cons() == 0)
				return;
			// add the net
			groups.back().push_back(&n);
			// process all terminals connected to this net
			for (auto &term : n.core_terms())
			{
				// only process analog terminals
				if (term->is_type(detail::terminal_type::TERMINAL))
				{
					auto *pt = static_cast<terminal_t *>(term);
					// check the connected terminal
					analog_net_t &connected_net = pt->connected_terminal()->net();
					if (!already_processed(connected_net))
						process_net(connected_net);
				}
			}
		}

		void run(netlist_state_t &netlist)
		{
			for (auto & net : netlist.nets())
			{
				netlist.log().debug("processing {1}\n", net->name());
				if (!net->isRailNet() && net->num_cons() > 0)
				{
					netlist.log().debug("   ==> not a rail net\n");
					// Must be an analog net
					auto &n = *static_cast<analog_net_t *>(net.get());
					if (!already_processed(n))
					{
						groups.emplace_back(analog_net_t::list_t());
						process_net(n);
					}
				}
			}
		}

		std::vector<analog_net_t::list_t> groups;
	};

	void NETLIB_NAME(solver)::post_start()
	{
		log().verbose("Scanning net groups ...");
		// determine net groups

		net_splitter splitter;

		splitter.run(state());

		// setup the solvers
		log().verbose("Found {1} net groups in {2} nets\n", splitter.groups.size(), state().nets().size());
		for (auto & grp : splitter.groups)
		{
			plib::unique_ptr<solver::matrix_solver_t> ms;
			pstring sname = plib::pfmt("Solver_{1}")(m_mat_solvers.size());

			switch (m_params.m_fp_type())
			{
				case solver::matrix_fp_type_e::FLOAT:
#if (NL_USE_FLOAT_MATRIX)
					ms = create_solvers<float>(sname, grp);
#else
					ms = create_solvers<double>(sname, grp);
#endif
					break;
				case solver::matrix_fp_type_e::DOUBLE:
					ms = create_solvers<double>(sname, grp);
					break;
				case solver::matrix_fp_type_e::LONGDOUBLE:
#if (NL_USE_LONG_DOUBLE_MATRIX)
					ms = create_solvers<long double>(sname, grp);
#else
					ms = create_solvers<double>(sname, grp);
#endif
					break;
				case solver::matrix_fp_type_e::FLOAT128:
#if (NL_USE_FLOAT128)
					ms = create_solvers<__float128>(sname, grp);
#else
					ms = create_solvers<double>(sname, grp);
#endif
					break;
			}

			log().verbose("Solver {1}", ms->name());
			log().verbose("       ==> {1} nets", grp.size());
			log().verbose("       has {1} elements", ms->has_dynamic_devices() ? "dynamic" : "no dynamic");
			log().verbose("       has {1} elements", ms->has_timestep_devices() ? "timestep" : "no timestep");
			for (auto &n : grp)
			{
				log().verbose("Net {1}", n->name());
				for (const auto &pcore : n->core_terms())
				{
					log().verbose("   {1}", pcore->name());
				}
			}

			m_mat_solvers_all.push_back(ms.get());
			if (ms->has_timestep_devices())
				m_mat_solvers_timestepping.push_back(ms.get());

			m_mat_solvers.emplace_back(std::move(ms));
		}
	}

	void NETLIB_NAME(solver)::create_solver_code(std::map<pstring, pstring> &mp)
	{
		for (auto & s : m_mat_solvers)
		{
			auto r = s->create_solver_code();
			mp[r.first] = r.second; // automatically overwrites identical names
		}
	}

	NETLIB_DEVICE_IMPL(solver, "SOLVER", "FREQ")

} // namespace devices
} // namespace netlist