Show / Hide Table of Contents

Interface ITruncatingBehavior

Describes a class that is capable of truncating a timestep.

Inherited Members
IBehavior.Name
IParameterSetCollection.GetParameterSet<P>()
IParameterSetCollection.TryGetParameterSet<P>(out P)
IParameterSetCollection.ParameterSets
IParameterSet.SetParameter<P>(string, P)
IParameterSet.TrySetParameter<P>(string, P)
IParameterSet.GetProperty<P>(string)
IParameterSet.TryGetProperty<P>(string, out P)
IParameterSet.CreateParameterSetter<P>(string)
IParameterSet.CreatePropertyGetter<P>(string)
Namespace: SpiceSharp.Behaviors
Assembly: SpiceSharp.dll
Syntax
public interface ITruncatingBehavior : IBehavior, IParameterSetCollection, IParameterSet

Methods

Evaluate()

Evaluate the currently calculated solution and return the maximum timestep that this behavior allows.

Declaration
double Evaluate()
Returns
Type Description
double

The timestep.

Prepare()

Calculate the maximum timestep that the behavior allows for our next time point.

Declaration
double Prepare()
Returns
Type Description
double

The timestep.

Extension Methods

Utility.ThrowIfNull<T>(T, string)
Documentation.ParameterValues<T>(IParameterSet, bool)
Documentation.Parameters(IParameterSet)
Documentation.ParameterValues<T>(IParameterSetCollection, bool)
Documentation.Parameters(IParameterSetCollection)
In this article
Back to top Generated by DocFX