Rate and State Framework

rsfmodel.rsf

exception rsfmodel.rsf.IncompleteModelError

Bases: exceptions.Exception

Special error case for trying to run the model with inadequate information.

class rsfmodel.rsf.LoadingSystem

Bases: object

Contains attributes relating to the external loading system.

Attributes

k	(float) System stiffness in units of fricton/displacement.
time	(list) List of time values at which the system will be solved.
loadpoint_velocity	(list) List of the imposed loadpoint velocities at the corresponding time value. Must be same length as time.
v	(float) Slider velocity
mu	(float) The current friciton value of the system.

Methods

friction_evolution(loadpoint_vel)

velocity_evolution()

class rsfmodel.rsf.Model

Bases: rsfmodel.rsf.LoadingSystem

Houses the model coefficients and does the integration.

Attributes

mu0	(float) Reference friction value at vref.
a	(float) Rate and state constitutive parameter.
vref	(float) System reference velocity at which the reference friction is measured.
state_relations	(list) List of state relations to be used when calculating the model.
results	(namedtuple) Stores all model outputs.

Methods

readyCheck()

Determines if all necessary parameters are set to run the model. Will raise appropriate error as necessary.

solve(threshold=2, **kwargs)

Runs the integrator to actually solve the model and returns a named tuple of results.

Parameters:

threshold : float

Threshold used to determine when integration care should be taken. This threshold is in terms of maximum load-point acceleration before time step is marked.

Returns:

results : named tuple

Results of the model