SICOPOLIS V5-dev  Revision 1264
Public Attributes | List of all members
revolve::rvAction Type Reference

this encapsulates all the information needed to perfrom the correct action an instance is returned from rvNextAction More...

Public Attributes

integer actionflag = 0
 the action that is to be implemented, termination, or error; the value must be one of: rvStore, rvRestore, rvForward, rvFirstUTurn, rvUTurn, rvDone, rvError More...
 
integer iteration = 0
 assumptions: More...
 
integer startiteration = 0
 assuming the loop iterations are in [0,ourSteps-1] and currentIteration variable is maintained, the interpretation is as follows based on the value of actionFlag: More...
 
integer cpnum = 0
 the checkpoint number to be stored to restored the value is meaninfull only if actionFlag is set to rvStore or rvRestore; More...
 
character(80) errormsgrevolve
 if an error has occurred actionFlag will be set to rvError and this will contain an error message More...
 

Detailed Description

this encapsulates all the information needed to perfrom the correct action an instance is returned from rvNextAction

Definition at line 62 of file revolve.f90.

Member Data Documentation

integer revolve::rvAction::actionflag = 0

the action that is to be implemented, termination, or error; the value must be one of: rvStore, rvRestore, rvForward, rvFirstUTurn, rvUTurn, rvDone, rvError

Definition at line 67 of file revolve.f90.

integer revolve::rvAction::cpnum = 0

the checkpoint number to be stored to restored the value is meaninfull only if actionFlag is set to rvStore or rvRestore;

This is approximately equivalent to checks in Alg. 799.

Definition at line 94 of file revolve.f90.

character(80) revolve::rvAction::errormsgrevolve

if an error has occurred actionFlag will be set to rvError and this will contain an error message

Definition at line 97 of file revolve.f90.

integer revolve::rvAction::iteration = 0

assumptions:

  • the loop iterations are numbered in range [0,ourSteps-1]
  • the model state is the input to the iteration numbered startIteration

the interpretation is as follows based on the value of actionFlag:

  • rvForward: execute iterations as the loop: do currentIteration=startIteration, iteration-1
  • rvRestore: restores model state at iteration (here it has the same value as startIteration)
  • rvFirstUTurn/rvUTurn: tape iterations in loop: do currentIteration=startIteration, iteration-1` followed by adjoint sweep over iterations in loop: do currentIteration=iteration-1,startIteration,-1

for all other values of actionFlag the value of iteration is meaningless

Definition at line 80 of file revolve.f90.

integer revolve::rvAction::startiteration = 0

assuming the loop iterations are in [0,ourSteps-1] and currentIteration variable is maintained, the interpretation is as follows based on the value of actionFlag:

  • rvForward: execute iterations as the loop: do currentIteration, iteration-1
  • rvRestore: set currentIteration=iteration

for all other values of actionFlag the value of iteration is meaningless

Definition at line 88 of file revolve.f90.


The documentation for this type was generated from the following file: