An abstract class representing an Application Interface (API).
It defines the required functionality provided by individual applications.
-
giveAssemblyTime(tstep)[source]
Returns the assembly time related to given time step.
The registered fields (inputs) should in general correspond to this time.
-
giveCriticalTimeStep()[source]
Returns the actual (related to current state) critical time step.
-
giveField(fieldID, tstep)[source]
Returns the requested field at given time. Field is identified by fieldID.
Returns an error code if not succesfull.
-
giveMesh(tstep)[source]
Returns the computational mesh for given solution step.
-
isConverged(tstep)[source]
Returns True if convergence reached for given solution step.
-
registerField(field, tstep)[source]
Registers the given (remote) field in application.
-
solve(tstep)[source]
Proceeds the solution from actual state to given time.
Returns an error code.
-
updateField(field, tstep)[source]
Updates the provided field values to given time.
Returns an error code if not succesfull.