File: TimeStepper.hpp

package info (click to toggle)
yade 2026.1.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 34,448 kB
  • sloc: cpp: 97,645; python: 52,173; sh: 677; makefile: 162
file content (40 lines) | stat: -rw-r--r-- 1,410 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
/*************************************************************************
*  Copyright (C) 2004 by Olivier Galizzi                                 *
*  olivier.galizzi@imag.fr                                               *
*                                                                        *
*  This program is free software; it is licensed under the terms of the  *
*  GNU General Public License v2 or later. See file LICENSE for details. *
*************************************************************************/

#pragma once

#include "GlobalEngine.hpp"
#include "Interaction.hpp"
#include "Scene.hpp"

namespace yade { // Cannot have #include directive inside.

class Body;

class TimeStepper : public GlobalEngine {
public:
	virtual void computeTimeStep(Scene*) { throw; };
	bool         isActivated() override { return (active && (scene->iter % timeStepUpdateInterval == 0)); };
	void         action() override { computeTimeStep(scene); };
	void         setActive(bool a, int nb = -1)
	{
		active = a;
		if (nb > 0) { timeStepUpdateInterval = (unsigned int)nb; }
	}

	// clang-format off
		YADE_CLASS_BASE_DOC_ATTRS(
			TimeStepper,GlobalEngine,"Engine defining time-step (fundamental class)",
			((bool,active,true,,"is the engine active?"))
			((unsigned int,timeStepUpdateInterval,1,,"dt update interval")));
	// clang-format on
};

REGISTER_SERIALIZABLE(TimeStepper);

} // namespace yade