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

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

Public Member Functions

subroutine readivarwdefault (UnIn, Fil, Var, VarName, VarDescr, VarDefault, ErrStat, ErrMsg, UnEc)
 This routine reads a scalar variable from the next line of the input file. More...
 
subroutine readlvarwdefault (UnIn, Fil, Var, VarName, VarDescr, VarDefault, ErrStat, ErrMsg, UnEc)
 This routine reads a logical variable from the next line of the input file. More...
 
subroutine readr4varwdefault (UnIn, Fil, Var, VarName, VarDescr, VarDefault, ErrStat, ErrMsg, UnEc)
 This routine reads a scalar variable from the next line of the input file. More...
 
subroutine readr8varwdefault (UnIn, Fil, Var, VarName, VarDescr, VarDefault, ErrStat, ErrMsg, UnEc)
 This routine reads a scalar variable from the next line of the input file. More...
 
subroutine readr16varwdefault (UnIn, Fil, Var, VarName, VarDescr, VarDefault, ErrStat, ErrMsg, UnEc)
 This routine reads a scalar variable from the next line of the input file. More...
 

Detailed Description

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

Use ReadVarWDefault (nwtc_io::readvarwdefault) instead of directly calling a specific routine in the generic interface. WARNING: this routine limits the size of the number being read to 30 characters

Parameters
[out]varvariable being read
[in]vardefaultdefault value of variable being read
[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
[in]filName of the input file.
[in]vardescrText string describing the variable.
[in]varnameText string containing the variable name.

Member Function/Subroutine Documentation

◆ readivarwdefault()

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

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

Use ReadVarWDefault (nwtc_io::readvarwdefault) instead of directly calling a specific routine in the generic interface. WARNING: this routine limits the size of the number being read to 30 characters

Parameters
[out]varvariable being read
[in]vardefaultdefault value of variable being read
[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
[in]filName of the input file.
[in]vardescrText string describing the variable.
[in]varnameText string containing the variable name.

◆ readlvarwdefault()

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

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

Use ReadVarWDefault (nwtc_io::readvarwdefault) instead of directly calling a specific routine in the generic interface. WARNING: this routine limits the size of the number being read to 30 characters

Parameters
[out]varvariable being read
[in]vardefaultdefault value of variable being read
[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
[in]filName of the input file.
[in]vardescrText string describing the variable.
[in]varnameText string containing the variable name.

◆ readr16varwdefault()

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

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

Use ReadVarWDefault (nwtc_io::readvarwdefault) instead of directly calling a specific routine in the generic interface. WARNING: this routine limits the size of the number being read to 30 characters

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

◆ readr4varwdefault()

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

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

Use ReadVarWDefault (nwtc_io::readvarwdefault) instead of directly calling a specific routine in the generic interface. WARNING: this routine limits the size of the number being read to 30 characters

Parameters
[out]varvariable being read
[in]vardefaultdefault value of variable being read
[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
[in]filName of the input file.
[in]vardescrText string describing the variable.
[in]varnameText string containing the variable name.

◆ readr8varwdefault()

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

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

Use ReadVarWDefault (nwtc_io::readvarwdefault) instead of directly calling a specific routine in the generic interface. WARNING: this routine limits the size of the number being read to 30 characters

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

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