OpenFAST
Wind turbine multiphysics simulator
Functions/Subroutines
extptfm_mckf_io Module Reference

This module contains file I/O routines and data validation routines. More...

Functions/Subroutines

subroutine seterrstatsimple (ErrStat, ErrMess, RoutineName, LineNumber)
 Helper functions for the module. More...
 
subroutine disp2r8 (u, varname, a)
 
subroutine disp1r8 (u, varname, a)
 
subroutine disp1i (u, varname, a)
 
real(reki) function readfloatfromstr (s, VarName, iStat, Msg)
 Helper functions to read primary file.
 
integer function readintfromstr (s, VarName, iStat, Msg)
 
subroutine readrealmatrix (fid, FileName, Mat, VarName, nLines, nRows, iStat, Msg, iLine)
 
subroutine, public setoutparam (OutList, NumOuts_in, p, ErrStat, ErrMsg)
 
subroutine checkinputs (Inp, p, ErrStat, ErrMsg)
 Checks that all inputs were correctly read. More...
 
subroutine, public readprimaryfile (InputFile, p, OutFileRoot, InputFileData, ErrStat, ErrMsg)
 
subroutine reducenumberofdof (p, ErrStat, ErrMsg)
 Reduce the number of degrees of freedom given as input. More...
 
subroutine readreducedfile (InputFile, p, FileFormat, ErrStat, ErrMsg)
 
subroutine, public extptfm_printsum (x, p, m, RootName, ErrStat, ErrMsg)
 This routine generates the summary file, which contains a regurgitation of the input data and interpolated flexible body data. More...
 

Detailed Description

This module contains file I/O routines and data validation routines.

Function/Subroutine Documentation

◆ checkinputs()

subroutine extptfm_mckf_io::checkinputs ( type(extptfm_inputfile), intent(inout)  Inp,
type(extptfm_parametertype), intent(inout)  p,
integer(intki), intent(out)  ErrStat,
character(*), intent(out)  ErrMsg 
)
private

Checks that all inputs were correctly read.

Parameters
[in,out]inpData stored in the module's input file
[in,out]pAll the parameter matrices stored in this input file
[out]errstatError status
[out]errmsgError message

◆ extptfm_printsum()

subroutine, public extptfm_mckf_io::extptfm_printsum ( type(extptfm_continuousstatetype), intent(in)  x,
type(extptfm_parametertype), intent(in)  p,
type(extptfm_miscvartype), intent(in)  m,
character(*), intent(in)  RootName,
integer(intki), intent(out)  ErrStat,
character(*), intent(out)  ErrMsg 
)

This routine generates the summary file, which contains a regurgitation of the input data and interpolated flexible body data.

Parameters
[in]xInitial continuous states
[in]pParameters of the structural dynamics module
[in]mMisc variables for optimization (not copied in glue code)
[in]rootnameRoot Name to write the summary file
[out]errstatError status of the operation
[out]errmsgError message if ErrStat /= ErrID_None

◆ readprimaryfile()

subroutine, public extptfm_mckf_io::readprimaryfile ( character(*), intent(in)  InputFile,
type(extptfm_parametertype), intent(inout)  p,
character(*), intent(in)  OutFileRoot,
type(extptfm_inputfile), intent(out)  InputFileData,
integer(intki), intent(out)  ErrStat,
character(*), intent(out)  ErrMsg 
)
Parameters
[in]inputfileName of the file containing the primary input data
[in,out]pAll the parameter matrices stored in this input file
[in]outfilerootThe rootname of all the output files written by this routine.
[out]errstatError status
[out]errmsgError message

◆ readreducedfile()

subroutine extptfm_mckf_io::readreducedfile ( character(*), intent(in)  InputFile,
type(extptfm_parametertype), intent(inout)  p,
integer(intki), intent(in)  FileFormat,
integer(intki), intent(out)  ErrStat,
character(*), intent(out)  ErrMsg 
)
private
Parameters
[in]inputfileName of the file containing the primary input data
[in,out]pAll the parameter matrices stored in this input file
[in]fileformatFile format for reduction inputs
[out]errstatError status
[out]errmsgError message

◆ reducenumberofdof()

subroutine extptfm_mckf_io::reducenumberofdof ( type(extptfm_parametertype), intent(inout)  p,
integer(intki), intent(out)  ErrStat,
character(*), intent(out)  ErrMsg 
)
private

Reduce the number of degrees of freedom given as input.

Parameters
[in,out]pAll the parameter matrices stored in this input file
[out]errstatError status
[out]errmsgError message

◆ seterrstatsimple()

subroutine extptfm_mckf_io::seterrstatsimple ( integer(intki), intent(inout)  ErrStat,
character(*), intent(inout)  ErrMess,
character(*), intent(in)  RoutineName,
integer(intki), intent(in), optional  LineNumber 
)
private

Helper functions for the module.

This routine sets the error status and error message for a routine, it's a simplified version of SetErrStat from NWTC_Library

◆ setoutparam()

subroutine, public extptfm_mckf_io::setoutparam ( character(chanlen), dimension(:), intent(in)  OutList,
integer(intki), intent(in)  NumOuts_in,
type(extptfm_parametertype), intent(inout)  p,
integer(intki), intent(out)  ErrStat,
character(*), intent(out)  ErrMsg 
)
Parameters
[in]outlistThe list out user-requested outputs
[in]numouts_inEffective number of output channels
[in,out]pThe module parameters
[out]errstatThe error status code
[out]errmsgThe error message, if an error occurred