Skip to content

Update timer example introducing the Newton Raphson #534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hugtalbot wants to merge 4 commits into
base: master
Choose a base branch
from
+21 −18
Open

Update timer example introducing the Newton Raphson #534

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4465bdf
Update timer example introducing the Newton Raphson
hugtalbot Sep 16, 2025
2110c52
fix timer end
hugtalbot Sep 16, 2025
3a3a3e3
Merge branch 'master' into 202508_lifecycle_v2512_disable_deprecated_…
hugtalbot Dec 12, 2025
019930d
fix all warnings, remove the timer Animate and the associated option …
hugtalbot Dec 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 21 additions & 18 deletions examples/advanced_timer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,39 +3,41 @@
from SofaRuntime import Timer


def dump_records(records, indent=0):
for k, v in records.items():
if isinstance(v, dict):
print(" " * indent + f"- {k}")
dump_records(v, indent + 1)
else:
print(" " * indent + f"- {k}: {v}")

# This controller will extract the timer records from the simulation at each steps
class TimerController(Sofa.Core.Controller):

def __init__(self, *args, **kwargs):
Sofa.Core.Controller.__init__(self, *args, **kwargs)

# This is needed to avoid a conflict with the timer of runSofa
self.use_sofa_profiler_timer = False

def onAnimateBeginEvent(self, event):
if len(Timer.getRecords('Animate')):
self.use_sofa_profiler_timer = True
else:
Timer.setEnabled("cg_timer", True)
Timer.begin("cg_timer")
Timer.setEnabled("timer", True)
Timer.begin("timer")

def onAnimateEndEvent(self, event):
if self.use_sofa_profiler_timer:
records = Timer.getRecords("Animate")
else:
records = Timer.getRecords("cg_timer")

records = Timer.getRecords("timer")

# Optional function to dump the full record
# dump_records(records)
step_time = records['solve']['Mechanical (meca)']['total_time']
print(f"Step took {step_time:.2f} ms")

nb_iterations = records['solve']['Mechanical (meca)']['StaticSolver::Solve']['nb_iterations']
for i in range(int(nb_iterations)):
nb_iterations = int(records['solve']['Mechanical (meca)']['StaticSolver::Solve']['nb_iterations'])

for i in range(nb_iterations):
total_time = records['solve']['Mechanical (meca)']['StaticSolver::Solve']['NewtonStep'][i]['total_time']
CG_iterations = records['solve']['Mechanical (meca)']['StaticSolver::Solve']['NewtonStep'][i]['MBKSolve']['CG iterations']
print(f" Newton iteration #{i} took {total_time:.2f} ms using {int(CG_iterations)} CG iterations")

if not self.use_sofa_profiler_timer:
Timer.end("cg_timer")
Timer.end("timer")


# Scene creation - This is automatically called by SofaPython3 when using runSofa
Expand Down Expand Up @@ -70,7 +72,8 @@ def createScene(root):

# Create our mechanical node
root.addChild("meca")
root.meca.addObject("StaticSolver", newton_iterations=5, printLog=False)
root.meca.addObject("NewtonRaphsonSolver", name="newtonSolver_springs", maxNbIterationsNewton=5, maxNbIterationsLineSearch=1, warnWhenLineSearchFails=False, printLog=False)
root.meca.addObject("StaticSolver", newtonSolver="@newtonSolver_springs")
root.meca.addObject("CGLinearSolver", iterations=25, tolerance=1e-5, threshold=1e-5)

root.meca.addObject('MechanicalObject', name='mo', position='@../grid.position')
Expand Down
Loading