- Generated on Mon Apr 9 2018 20:02:20 for OpenCMISS-Iron Internal API Documentation by
1.8.11
|
OpenCMISS-Iron Internal API Documentation
|
This module handles all control loop routines. More...
Go to the source code of this file.
Data Types | |
| interface | control_loop_routines::control_loop_get |
| Returns the specified control loop as indexed by the control loop identifier from the control loop root. More... | |
| interface | control_loop_routines::control_loop_label_get |
| interface | control_loop_routines::control_loop_label_set |
Modules | |
| module | control_loop_routines |
| This module handles all control loop routines. | |
Functions/Subroutines | |
| recursive subroutine, public | control_loop_routines::control_loop_create_finish (CONTROL_LOOP, ERR, ERROR,) |
| Finish the process of creating a control loop. More... | |
| subroutine, public | control_loop_routines::control_loop_create_start (PROBLEM, CONTROL_LOOP, ERR, ERROR,) |
| Start the process of creating a control loop for a problem. More... | |
| subroutine, public | control_loop_routines::control_loop_current_times_get (CONTROL_LOOP, CURRENT_TIME, TIME_INCREMENT, ERR, ERROR,) |
| Gets the current time parameters for a time control loop. More... | |
| subroutine, public | control_loop_routines::control_loop_destroy (CONTROL_LOOP, ERR, ERROR,) |
| Destroy a control loop. More... | |
| recursive subroutine | control_loop_routines::control_loop_finalise (CONTROL_LOOP, ERR, ERROR,) |
| Finalise a control loop and deallocate all memory. More... | |
| subroutine | control_loop_routines::control_loop_initialise (PROBLEM, ERR, ERROR,) |
| Initialise the control for a problem. More... | |
| subroutine | control_loop_routines::control_loop_fixed_finalise (FIXED_LOOP, ERR, ERROR,) |
| Finalises a fixed control loop and deallocates all memory. More... | |
| subroutine | control_loop_routines::control_loop_get_0 (CONTROL_LOOP_ROOT, CONTROL_LOOP_IDENTIFIER, CONTROL_LOOP, ERR, ERROR,) |
| Returns the specified control loop as indexed by the control loop identifier from the control loop root. More... | |
| subroutine | control_loop_routines::control_loop_get_1 (CONTROL_LOOP_ROOT, CONTROL_LOOP_IDENTIFIER, CONTROL_LOOP, ERR, ERROR,) |
| Returns the specified control loop as indexed by the control loop identifier from the control loop root. More... | |
| subroutine | control_loop_routines::control_loop_fixed_initialise (CONTROL_LOOP, ERR, ERROR,) |
| Initialises a fixed loop for a control loop. More... | |
| subroutine, public | control_loop_routines::control_loop_iterations_set (CONTROL_LOOP, START_ITERATION, STOP_ITERATION, ITERATION_INCREMENT, ERR, ERROR,) |
| Sets the iteration parameters for a fixed control loop. More... | |
| subroutine | control_loop_routines::control_loop_label_get_c (CONTROL_LOOP, LABEL, ERR, ERROR,) |
| Returns the label of a control loop. More... | |
| subroutine | control_loop_routines::control_loop_label_get_vs (CONTROL_LOOP, LABEL, ERR, ERROR,) |
| Returns the label of a control loop. More... | |
| subroutine | control_loop_routines::control_loop_label_set_c (CONTROL_LOOP, LABEL, ERR, ERROR,) |
| Sets the label of a control loop. More... | |
| subroutine | control_loop_routines::control_loop_label_set_vs (CONTROL_LOOP, LABEL, ERR, ERROR,) |
| Sets the label of a control loop. More... | |
| subroutine, public | control_loop_routines::control_loop_maximum_iterations_set (CONTROL_LOOP, MAXIMUM_ITERATIONS, ERR, ERROR,) |
| Sets the maximum number of iterations for a while or load increment control loop. More... | |
| subroutine, public | control_loop_routines::control_loop_load_output_set (CONTROL_LOOP, OUTPUT_FREQUENCY, ERR, ERROR,) |
| Sets/changes the output for a load incremented control loop identified by an object. More... | |
| subroutine, public | control_loop_routines::controlloop_absolutetoleranceset (controlLoop, absoluteTolerance, err, error,) |
| Sets the absolute tolerance (convergence condition tolerance) for a while control loop. More... | |
| subroutine, public | control_loop_routines::control_loop_number_of_iterations_set (CONTROL_LOOP, NUMBER_OF_ITERATIONS, ERR, ERROR,) |
| Sets the number of iterations for a time type control loop. If set to 0 (default), it will be computed by start and stop time and time increment. More... | |
| subroutine, public | control_loop_routines::control_loop_number_of_iterations_get (CONTROL_LOOP, NUMBER_OF_ITERATIONS, ERR, ERROR,) |
| Gets the number of iterations for a time type control loop. If the value is not set to something /=0, it will be computed the first time the loop is executed. If it is retrieved earlier and 0 is returned, this means the value was not yet computed. More... | |
| subroutine, public | control_loop_routines::control_loop_number_of_sub_loops_get (CONTROL_LOOP, NUMBER_OF_SUB_LOOPS, ERR, ERROR,) |
| Gets the number of sub loops for a control loop. More... | |
| subroutine, public | control_loop_routines::control_loop_number_of_sub_loops_set (CONTROL_LOOP, NUMBER_OF_SUB_LOOPS, ERR, ERROR,) |
| Sets/changes the number of sub loops in a control loop. More... | |
| subroutine, public | control_loop_routines::control_loop_output_type_get (CONTROL_LOOP, OUTPUT_TYPE, ERR, ERROR,) |
| Gets the output type for a control loop. More... | |
| subroutine, public | control_loop_routines::control_loop_output_type_set (CONTROL_LOOP, OUTPUT_TYPE, ERR, ERROR,) |
| Sets/changes the output type for a control loop. More... | |
| subroutine | control_loop_routines::control_loop_simple_finalise (SIMPLE_LOOP, ERR, ERROR,) |
| Finalises a simple control loop and deallocates all memory. More... | |
| subroutine | control_loop_routines::control_loop_simple_initialise (CONTROL_LOOP, ERR, ERROR,) |
| Initialises a simple loop for a control loop. More... | |
| recursive subroutine, public | control_loop_routines::control_loop_solvers_destroy (CONTROL_LOOP, ERR, ERROR,) |
| Recursively destroys the solvers for a control loop and all sub control loops. More... | |
| recursive subroutine, public | control_loop_routines::control_loop_solvers_get (CONTROL_LOOP, SOLVERS, ERR, ERROR,) |
| Returns a pointer to the solvers for a control loop. More... | |
| recursive subroutine, public | control_loop_routines::control_loop_solver_equations_destroy (CONTROL_LOOP, ERR, ERROR,) |
| Recursively destroys the solver equations for a control loop and all sub control loops. More... | |
| subroutine, public | control_loop_routines::control_loop_sub_loop_get (CONTROL_LOOP, SUB_LOOP_INDEX, SUB_LOOP, ERR, ERROR,) |
| Gets/returns a pointer to the sub loops as specified by the sub loop index for a control loop. More... | |
| subroutine | control_loop_routines::control_loop_time_finalise (TIME_LOOP, ERR, ERROR,) |
| Finalises a time control loop and deallocates all memory. More... | |
| subroutine | control_loop_routines::control_loop_time_initialise (CONTROL_LOOP, ERR, ERROR,) |
| Initialises a time loop for a control loop. More... | |
| subroutine, public | control_loop_routines::control_loop_times_get (CONTROL_LOOP, START_TIME, STOP_TIME, CURRENT_TIME, TIME_INCREMENT, CURRENT_LOOP_ITERATION, OUTPUT_ITERATION_NUMBER, ERR, ERROR,) |
| Gets the current time parameters for a time control loop. More... | |
| subroutine, public | control_loop_routines::control_loop_times_set (CONTROL_LOOP, START_TIME, STOP_TIME, TIME_INCREMENT, ERR, ERROR,) |
| Sets the time parameters for a time control loop. More... | |
| subroutine, public | control_loop_routines::control_loop_time_output_set (CONTROL_LOOP, OUTPUT_FREQUENCY, ERR, ERROR,) |
| Sets the output parameters for a time control loop. More... | |
| subroutine, public | control_loop_routines::control_loop_time_input_set (CONTROL_LOOP, INPUT_OPTION, ERR, ERROR,) |
| Sets the input parameters for a time control loop. More... | |
| subroutine, public | control_loop_routines::control_loop_type_set (CONTROL_LOOP, LOOP_TYPE, ERR, ERROR,) |
| Sets/changes the control loop type. More... | |
| subroutine | control_loop_routines::control_loop_while_finalise (WHILE_LOOP, ERR, ERROR,) |
| Finalises a while control loop and deallocates all memory. More... | |
| subroutine | control_loop_routines::control_loop_while_initialise (CONTROL_LOOP, ERR, ERROR,) |
| Initialises a while loop for a control loop. More... | |
| subroutine | control_loop_routines::control_loop_load_increment_finalise (LOAD_INCREMENT_LOOP, ERR, ERROR,) |
| Finalises a load increment loop and deallocates all memory. More... | |
| subroutine | control_loop_routines::control_loop_load_increment_initialise (CONTROL_LOOP, ERR, ERROR,) |
| Initialises a load increment loop for a control loop. More... | |
Variables | |
| integer(intg), parameter, public | control_loop_routines::control_loop_node =0 |
| The identifier for a each "leaf" node in a control loop. More... | |
| integer(intg), parameter, public | control_loop_routines::control_loop_no_output =0 |
| No output from the control loop. More... | |
| integer(intg), parameter, public | control_loop_routines::control_loop_progress_output =1 |
| Progress output from control loop. More... | |
| integer(intg), parameter, public | control_loop_routines::control_loop_timing_output =2 |
| Timing output from the control loop. More... | |
This module handles all control loop routines.
Version: MPL 1.1/GPL 2.0/LGPL 2.1
The contents of this file are subject to the Mozilla Public License Version 1.1 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.mozilla.org/MPL/
Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License.
The Original Code is OpenCMISS
The Initial Developer of the Original Code is University of Auckland, Auckland, New Zealand, the University of Oxford, Oxford, United Kingdom and King's College, London, United Kingdom. Portions created by the University of Auckland, the University of Oxford and King's College, London are Copyright (C) 2007-2010 by the University of Auckland, the University of Oxford and King's College, London. All Rights Reserved.
Contributor(s):
Alternatively, the contents of this file may be used under the terms of either the GNU General Public License Version 2 or later (the "GPL"), or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), in which case the provisions of the GPL or the LGPL are applicable instead of those above. If you wish to allow use of your version of this file only under the terms of either the GPL or the LGPL, and not to allow others to use your version of this file under the terms of the MPL, indicate your decision by deleting the provisions above and replace them with the notice and other provisions required by the GPL or the LGPL. If you do not delete the provisions above, a recipient may use your version of this file under the terms of any one of the MPL, the GPL or the LGPL.
Definition in file control_loop_routines.f90.
1.8.11