Fortran wrapper for the FiDeviceFunctionFactory methods. More...
#include "FiDeviceFunctions/FiDeviceFunctionFactory.H"#include "FiDeviceFunctions/FiDeviceFunctionBase.H"#include "FFaLib/FFaCmdLineArg/FFaCmdLineArg.H"#include "FFaLib/FFaOS/FFaFortran.H"#include <cstring>
Include dependency graph for FiDeviceFunctionFactory_F.C:
Functions | |
| SUBROUTINE (fidf_open, FIDF_OPEN) const | |
| Opens a function device for reading. More... | |
| SUBROUTINE (fidf_openwrite, FIDF_OPENWRITE) const | |
| Opens a function device for writing. More... | |
| SUBROUTINE (fidf_close, FIDF_CLOSE) const | |
| Closes the file associated with the fileIndex. More... | |
| SUBROUTINE (fidf_closeall, FIDF_CLOSEALL)() | |
| Closes all open files. More... | |
| DOUBLE_FUNCTION (fidf_getvalue, FIDF_GETVALUE) const | |
| Returns a value from the device. More... | |
| SUBROUTINE (fidf_setvalue, FIDF_SETVALUE) const | |
| Sets a value pair to the device. More... | |
| SUBROUTINE (fidf_setfrequency, FIDF_SETFREQUENCY) const | |
| Defines the sampling frequency for the device. More... | |
| SUBROUTINE (fidf_setstep, FIDF_SETSTEP) const | |
| Defines the sampling step size for the device. More... | |
| SUBROUTINE (fidf_getxaxis, FIDF_GETXAXIS) const | |
| Returns X-axis info for the device. More... | |
| SUBROUTINE (fidf_getyaxis, FIDF_GETYAXIS) const | |
| Returns Y-axis info for the device. More... | |
| SUBROUTINE (fidf_setxaxis, FIDF_SETXAXIS) const | |
| Sets X-axis info for the device. More... | |
| SUBROUTINE (fidf_setyaxis, FIDF_SETYAXIS) const | |
| Sets Y-axis info for the device. More... | |
| SUBROUTINE (fidf_dump, FIDF_DUMP)() | |
| Dumps data about current device functions. More... | |
| SUBROUTINE (fidf_extfunc, FIDF_EXTFUNC) | |
| Opens a file for reading external function values. More... | |
| SUBROUTINE (fidf_extfunc_ff, FIDF_EXTFUNC_FF) const | |
| Updates the external function values from file. More... | |
| SUBROUTINE (fidf_storeextfunc, FIDF_STOREEXTFUNC) | |
| Transfers external function values to/from state array. More... | |
| SUBROUTINE (fidf_initextfunc, FIDF_INITEXTFUNC) | |
| Initializes external function values either from file or state array. More... | |
Detailed Description
Fortran wrapper for the FiDeviceFunctionFactory methods.
Function Documentation
◆ DOUBLE_FUNCTION()
| DOUBLE_FUNCTION | ( | fidf_getvalue | , |
| FIDF_GETVALUE | |||
| ) | const |
Returns a value from the device.
- fileIndex - Associated file index
- arg - Argument to the function to evaluate
- err - Error flag, on input it specifies the integration order
- channel - Channel index
- Returns
- Corresponding value, i.e., f(arg)
- Note
- Only valid for read-only devices.
◆ SUBROUTINE() [1/16]
| SUBROUTINE | ( | fidf_close | , |
| FIDF_CLOSE | |||
| ) | const |
Closes the file associated with the fileIndex.
◆ SUBROUTINE() [2/16]
| SUBROUTINE | ( | fidf_closeall | , |
| FIDF_CLOSEALL | |||
| ) |
Closes all open files.
◆ SUBROUTINE() [3/16]
| SUBROUTINE | ( | fidf_dump | , |
| FIDF_DUMP | |||
| ) |
Dumps data about current device functions.
◆ SUBROUTINE() [4/16]
| SUBROUTINE | ( | fidf_extfunc | , |
| FIDF_EXTFUNC | |||
| ) |
Opens a file for reading external function values.
- error - Error flag
- fname - File name
- label - Labels of file columns to use
◆ SUBROUTINE() [5/16]
| SUBROUTINE | ( | fidf_extfunc_ff | , |
| FIDF_EXTFUNC_FF | |||
| ) | const |
Updates the external function values from file.
- nstep - Number of steps to read
◆ SUBROUTINE() [6/16]
| SUBROUTINE | ( | fidf_getxaxis | , |
| FIDF_GETXAXIS | |||
| ) | const |
Returns X-axis info for the device.
- fileIndex - Associated file index
- title - Description of the axis (output)
- unit - The axis unit (output)
◆ SUBROUTINE() [7/16]
| SUBROUTINE | ( | fidf_getyaxis | , |
| FIDF_GETYAXIS | |||
| ) | const |
Returns Y-axis info for the device.
- fileIndex - Associated file index
- title - Description of the axis (output)
- unit - The axis unit (output)
◆ SUBROUTINE() [8/16]
| SUBROUTINE | ( | fidf_initextfunc | , |
| FIDF_INITEXTFUNC | |||
| ) |
Initializes external function values either from file or state array.
- data - The state array
- ndat - Length of the state array
- istat - Negative value on error, otherwise equals ndat
◆ SUBROUTINE() [9/16]
| SUBROUTINE | ( | fidf_open | , |
| FIDF_OPEN | |||
| ) | const |
Opens a function device for reading.
- name - Name of the file to open. The file extension is used to try to determine the file type. If this does not succeed, ASCII is assumed.
- fileIndex - Unique index for the opened file, used in other calls. A negative value indicates error.
- Note
- On input, the fileIndex argument contains the channel index.
◆ SUBROUTINE() [10/16]
| SUBROUTINE | ( | fidf_openwrite | , |
| FIDF_OPENWRITE | |||
| ) | const |
Opens a function device for writing.
- name - Name of the file to open
- fileType - Type of the file to open. If UNKNOWN_FILE, the file extension is used to try to determine the actual file type. If this does not succeed, a simple text file is opened.
- fileIndex - Unique index for the opened file, used in other calls. A negative value indicates error.
- Note
- Existing files are replaced.
◆ SUBROUTINE() [11/16]
| SUBROUTINE | ( | fidf_setfrequency | , |
| FIDF_SETFREQUENCY | |||
| ) | const |
Defines the sampling frequency for the device.
- fileIndex - Associated file index
- freq - Desired sampling frequency
- Note
- Only valid for write-only devices.
◆ SUBROUTINE() [12/16]
| SUBROUTINE | ( | fidf_setstep | , |
| FIDF_SETSTEP | |||
| ) | const |
Defines the sampling step size for the device.
- fileIndex - Associated file index
- step - Desired sampling step size
- Note
- Only valid for write-only devices.
◆ SUBROUTINE() [13/16]
| SUBROUTINE | ( | fidf_setvalue | , |
| FIDF_SETVALUE | |||
| ) | const |
Sets a value pair to the device.
- fileIndex - Associated file index
- first - First value (key) in the value pair
- second - Second value in the value pair
- Note
- Only valid for write-only devices.
◆ SUBROUTINE() [14/16]
| SUBROUTINE | ( | fidf_setxaxis | , |
| FIDF_SETXAXIS | |||
| ) | const |
Sets X-axis info for the device.
- fileIndex - Associated file index
- title - Description of the axis
- unit - The axis unit
◆ SUBROUTINE() [15/16]
| SUBROUTINE | ( | fidf_setyaxis | , |
| FIDF_SETYAXIS | |||
| ) | const |
Sets Y-axis info for the device.
- fileIndex - Associated file index
- title - Description of the axis
- unit - The axis unit
◆ SUBROUTINE() [16/16]
| SUBROUTINE | ( | fidf_storeextfunc | , |
| FIDF_STOREEXTFUNC | |||
| ) |
Transfers external function values to/from state array.
- data - The state array
- ndat - Length of the state array
- iop - 0: Return size in istat, 1: store values, 2: restore values
- istat - Running state array index, output negative on error
