drasil-code-0.1.9.0: A framework for code and document generation for scientific software - Code SubPackage
Safe HaskellSafe-Inferred
LanguageHaskell2010

Language.Drasil.Code.Imperative.Parameters

Synopsis

Documentation

getInConstructorParams :: GenState [CodeVarChunk] Source #

Since the input constructor calls the three input-related methods, the parameters to the constructor are the parameters to the three methods, except excluding any of variables that are state variables in the class, since they are already in scope. If InputParameters is not in the definition list, then the default constructor is used, which takes no parameters.

getInputFormatIns :: GenState [CodeVarChunk] Source #

The inputs to the function for reading inputs are the input file name, and the inParams object if inputs are bundled and input components are separated. The latter is needed because we want to populate the object through state transitions, not by returning it.

getInputFormatOuts :: GenState [CodeVarChunk] Source #

The outputs from the function for reading inputs are the inputs.

getDerivedIns :: GenState [CodeVarChunk] Source #

The inputs to the function for calculating derived inputs are any variables used in the equations for the derived inputs.

getDerivedOuts :: GenState [CodeVarChunk] Source #

The outputs from the function for calculating derived inputs are the derived inputs.

getConstraintParams :: GenState [CodeVarChunk] Source #

The parameters to the function for checking constraints on the inputs are any inputs with constraints, and any variables used in the expressions of the constraints.

getCalcParams :: CodeDefinition -> GenState [CodeVarChunk] Source #

The parameters to a calculation function are any variables used in the expression representing the calculation.

getOutputParams :: GenState [CodeVarChunk] Source #

The parameters to the function for printing outputs are the outputs.