OpenFAST
Wind turbine multiphysics simulator
Public Member Functions | List of all members
nwtc_io::readvar Interface Reference

This routine reads a variable from the next line of the input file. More...

Public Member Functions

subroutine readcvar (UnIn, Fil, Var, VarName, VarDescr, ErrStat, ErrMsg, UnEc)
 This routine reads a variable from the next line of the input file. More...
 
subroutine readivar (UnIn, Fil, Var, VarName, VarDescr, ErrStat, ErrMsg, UnEc)
 This routine reads a variable from the next line of the input file. More...
 
subroutine readlvar (UnIn, Fil, Var, VarName, VarDescr, ErrStat, ErrMsg, UnEc)
 This routine reads a variable from the next line of the input file. More...
 
subroutine readr4var (UnIn, Fil, Var, VarName, VarDescr, ErrStat, ErrMsg, UnEc)
 This routine reads a variable from the next line of the input file. More...
 
subroutine readr8var (UnIn, Fil, Var, VarName, VarDescr, ErrStat, ErrMsg, UnEc)
 This routine reads a variable from the next line of the input file. More...
 
subroutine readr16var (UnIn, Fil, Var, VarName, VarDescr, ErrStat, ErrMsg, UnEc)
 This routine reads a variable from the next line of the input file. More...
 

Detailed Description

This routine reads a variable from the next line of the input file.

Use ReadVar (nwtc_io::readvar) instead of directly calling a specific routine in the generic interface.

Parameters
[in]uninI/O unit for input file.
[in]unecI/O unit for echo file. If present and > 0, write to UnEc
[out]errstatError status; if present, program does not abort on error
[out]errmsgError message
[out]varVariable being read
[in]filName of the input file.
[in]vardescrText string describing the variable.
[in]varnameText string containing the variable name.

Member Function/Subroutine Documentation

◆ readcvar()

subroutine nwtc_io::readvar::readcvar ( integer, intent(in)  UnIn,
character(*), intent(in)  Fil,
character(*), intent(out)  Var,
character(*), intent(in)  VarName,
character(*), intent(in)  VarDescr,
integer(intki), intent(out)  ErrStat,
character(*), intent(out)  ErrMsg,
integer, intent(in), optional  UnEc 
)

This routine reads a variable from the next line of the input file.

Use ReadVar (nwtc_io::readvar) instead of directly calling a specific routine in the generic interface.

Parameters
[in]uninI/O unit for input file.
[in]unecI/O unit for echo file. If present and > 0, write to UnEc
[out]errstatError status; if present, program does not abort on error
[out]errmsgError message
[out]varVariable being read
[in]filName of the input file.
[in]vardescrText string describing the variable.
[in]varnameText string containing the variable name.

◆ readivar()

subroutine nwtc_io::readvar::readivar ( integer, intent(in)  UnIn,
character(*), intent(in)  Fil,
integer, intent(out)  Var,
character(*), intent(in)  VarName,
character(*), intent(in)  VarDescr,
integer(intki), intent(out)  ErrStat,
character(*), intent(out)  ErrMsg,
integer, intent(in), optional  UnEc 
)

This routine reads a variable from the next line of the input file.

Use ReadVar (nwtc_io::readvar) instead of directly calling a specific routine in the generic interface.

Parameters
[in]uninI/O unit for input file.
[in]unecI/O unit for echo file. If present and > 0, write to UnEc
[out]errstatError status; if present, program does not abort on error
[out]errmsgError message
[out]varVariable being read
[in]filName of the input file.
[in]vardescrText string describing the variable.
[in]varnameText string containing the variable name. WARNING: this routine limits the size of the number being read to 30 characters

◆ readlvar()

subroutine nwtc_io::readvar::readlvar ( integer, intent(in)  UnIn,
character(*), intent(in)  Fil,
logical, intent(out)  Var,
character(*), intent(in)  VarName,
character(*), intent(in)  VarDescr,
integer(intki), intent(out)  ErrStat,
character(*), intent(out)  ErrMsg,
integer, intent(in), optional  UnEc 
)

This routine reads a variable from the next line of the input file.

Use ReadVar (nwtc_io::readvar) instead of directly calling a specific routine in the generic interface.

Parameters
[in]uninI/O unit for input file.
[in]unecI/O unit for echo file. If present and > 0, write to UnEc
[out]errstatError status; if present, program does not abort on error
[out]errmsgError message
[out]varVariable being read
[in]filName of the input file.
[in]vardescrText string describing the variable.
[in]varnameText string containing the variable name.

◆ readr16var()

subroutine nwtc_io::readvar::readr16var ( integer, intent(in)  UnIn,
character( *), intent(in)  Fil,
real(quki), intent(out)  Var,
character( *), intent(in)  VarName,
character( *), intent(in)  VarDescr,
integer(intki), intent(out), optional  ErrStat,
character(*), intent(out), optional  ErrMsg,
integer, intent(in), optional  UnEc 
)

This routine reads a variable from the next line of the input file.

Use ReadVar (nwtc_io::readvar) instead of directly calling a specific routine in the generic interface.

Parameters
[in]uninI/O unit for input file.
[in]unecI/O unit for echo file. If present and > 0, write to UnEc
[out]errstatError status; if present, program does not abort on error
[out]errmsgError message
[out]varVariable being read
[in]filName of the input file.
[in]vardescrText string describing the variable.
[in]varnameText string containing the variable name. WARNING: this routine limits the size of the number being read to 30 characters

◆ readr4var()

subroutine nwtc_io::readvar::readr4var ( integer, intent(in)  UnIn,
character( *), intent(in)  Fil,
real(siki), intent(out)  Var,
character( *), intent(in)  VarName,
character( *), intent(in)  VarDescr,
integer(intki), intent(out)  ErrStat,
character(*), intent(out)  ErrMsg,
integer, intent(in), optional  UnEc 
)

This routine reads a variable from the next line of the input file.

Use ReadVar (nwtc_io::readvar) instead of directly calling a specific routine in the generic interface.

Parameters
[in]uninI/O unit for input file.
[in]unecI/O unit for echo file. If present and > 0, write to UnEc
[out]errstatError status; if present, program does not abort on error
[out]errmsgError message
[out]varVariable being read
[in]filName of the input file.
[in]vardescrText string describing the variable.
[in]varnameText string containing the variable name. WARNING: this routine limits the size of the number being read to 30 characters

◆ readr8var()

subroutine nwtc_io::readvar::readr8var ( integer, intent(in)  UnIn,
character( *), intent(in)  Fil,
real(r8ki), intent(out)  Var,
character( *), intent(in)  VarName,
character( *), intent(in)  VarDescr,
integer(intki), intent(out)  ErrStat,
character(*), intent(out)  ErrMsg,
integer, intent(in), optional  UnEc 
)

This routine reads a variable from the next line of the input file.

Use ReadVar (nwtc_io::readvar) instead of directly calling a specific routine in the generic interface.

Parameters
[in]uninI/O unit for input file.
[in]unecI/O unit for echo file. If present and > 0, write to UnEc
[out]errstatError status; if present, program does not abort on error
[out]errmsgError message
[out]varVariable being read
[in]filName of the input file.
[in]vardescrText string describing the variable.
[in]varnameText string containing the variable name. WARNING: this routine limits the size of the number being read to 30 characters

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