pyopensn.solver.TransientSolver

class pyopensn.solver.TransientSolver

Transient solver.

Wrapper of opensn::TransientSolver.

Advance(self: pyopensn.solver.TransientSolver) → None

Advance the solver by a single timestep.

Notes

You must call Initialize() before calling Advance() or Execute().

Execute(self: pyopensn.solver.Solver) → None

Execute the solver.

Initialize(self: pyopensn.solver.Solver) → None

Initialize the solver.

SetPostAdvanceCallback(*args, **kwargs)

Overloaded function.

  1. SetPostAdvanceCallback(self: pyopensn.solver.TransientSolver, arg0: Callable[[], None]) -> None

    Register a callback that runs after each advance within Execute().

    callbackOptional[Callable[[], None]]

    Function invoked after the solver advances a timestep. Pass None to clear.

  2. SetPostAdvanceCallback(self: pyopensn.solver.TransientSolver, arg0: None) -> None

Clear the PostAdvance callback by passing None.

SetPreAdvanceCallback(*args, **kwargs)

Overloaded function.

  1. SetPreAdvanceCallback(self: pyopensn.solver.TransientSolver, arg0: Callable[[], None]) -> None

    Register a callback that runs before each advance within Execute().

    callbackOptional[Callable[[], None]]

    Function invoked before the solver advances a timestep. Pass None to clear. If the callback modifies the timestep, the new value is used for the upcoming step.

  2. SetPreAdvanceCallback(self: pyopensn.solver.TransientSolver, arg0: None) -> None

Clear the PreAdvance callback by passing None.

SetTheta(self: pyopensn.solver.TransientSolver, arg0: float) → None

Set the theta parameter used by Advance().

Parameters:

theta (float) – Theta value between 1.0e-16 and 1.

SetTimeStep(self: pyopensn.solver.TransientSolver, arg0: float) → None

Set the timestep size used by Advance().

Parameters:

dt (float) – New timestep size.

__init__(self: pyopensn.solver.TransientSolver, **kwargs) → None

Construct a transient solver.

Parameters:

  • pyopensn.solver.DiscreteOrdinatesProblem (DiscreteOrdinatesProblem) – Existing discrete ordinates problem instance.

  • dt (float, optional, default=2.0e-3) – Time step size used during the simulation.

  • stop_time (float, optional, default=0.1) – Simulation end time.

  • theta (float, optional, default=0.5) – Time differencing scheme parameter.

  • initial_state (str, optional, default="existing") – Initial state for the transient solve. Allowed values: existing, zero. In “zero” mode, the solver may initialize the problem internally if needed.

  • verbose (bool, optional, default=True) – Enable verbose logging.