drasil-code-0.1.9.0: A framework for code and document generation for scientific software - Code SubPackage
Safe HaskellNone
LanguageGHC2024

Language.Drasil.CodeSpec

Description

Defines the CodeSpec structure and related functions.

Synopsis

Types

type Input = CodeVarChunk Source #

Program input.

type Output = CodeVarChunk Source #

Program output.

type Const = CodeDefinition Source #

Constants in the problem.

type Derived = CodeDefinition Source #

Derived inputs.

type ConstantMap = Map UID CodeDefinition Source #

Maps constants to their respective CodeDefinition.

data CodeSpec Source #

Code Specification. Holds system information and options.

Instances

Instances details
HasCodeSpec CodeSpec Source # 
Instance details

Defined in Language.Drasil.CodeSpec

Methods

codeSpec :: Lens' CodeSpec CodeSpec Source #

cMap :: Lens' CodeSpec ConstraintCEMap Source #

configFiles :: Lens' CodeSpec [RelativeFile] Source #

constDefns :: Lens' CodeSpec [Const] Source #

constMap :: Lens' CodeSpec ConstantMap Source #

csSysMeta :: Lens' CodeSpec SystemMeta Source #

derivedInputs :: Lens' CodeSpec [Derived] Source #

execOrder :: Lens' CodeSpec [Def] Source #

extInputs :: Lens' CodeSpec [Input] Source #

inputs :: Lens' CodeSpec [Input] Source #

mods :: Lens' CodeSpec [Mod] Source #

outputs :: Lens' CodeSpec [Output] Source #

HasSystemMeta CodeSpec Source # 
Instance details

Defined in Language.Drasil.CodeSpec

Methods

systemMeta :: Lens' CodeSpec SystemMeta #

authors :: Lens' CodeSpec People #

background :: Lens' CodeSpec Background #

motivation :: Lens' CodeSpec Motivation #

projName :: Lens' CodeSpec ProjectName #

purpose :: Lens' CodeSpec Purpose #

scope :: Lens' CodeSpec Scope #

systemdb :: Lens' CodeSpec ChunkDB #

HasProjectName CodeSpec Source # 
Instance details

Defined in Language.Drasil.CodeSpec

Methods

projectName :: Lens' CodeSpec ProjectName #

projAbrv :: Lens' CodeSpec String #

projRepoName :: Lens' CodeSpec String #

projTitle :: Lens' CodeSpec NP #

Typeclasses

class HasCodeSpec c where Source #

Minimal complete definition

codeSpec

Methods

codeSpec :: Lens' c CodeSpec Source #

cMap :: Lens' c ConstraintCEMap Source #

configFiles :: Lens' c [RelativeFile] Source #

constDefns :: Lens' c [Const] Source #

constMap :: Lens' c ConstantMap Source #

csSysMeta :: Lens' c SystemMeta Source #

derivedInputs :: Lens' c [Derived] Source #

execOrder :: Lens' c [Def] Source #

extInputs :: Lens' c [Input] Source #

inputs :: Lens' c [Input] Source #

mods :: Lens' c [Mod] Source #

outputs :: Lens' c [Output] Source #

Instances

Instances details
HasCodeSpec DrasilState Source # 
Instance details

Defined in Language.Drasil.Code.Imperative.DrasilState

Methods

codeSpec :: Lens' DrasilState CodeSpec Source #

cMap :: Lens' DrasilState ConstraintCEMap Source #

configFiles :: Lens' DrasilState [RelativeFile] Source #

constDefns :: Lens' DrasilState [Const] Source #

constMap :: Lens' DrasilState ConstantMap Source #

csSysMeta :: Lens' DrasilState SystemMeta Source #

derivedInputs :: Lens' DrasilState [Derived] Source #

execOrder :: Lens' DrasilState [Def] Source #

extInputs :: Lens' DrasilState [Input] Source #

inputs :: Lens' DrasilState [Input] Source #

mods :: Lens' DrasilState [Mod] Source #

outputs :: Lens' DrasilState [Output] Source #

HasCodeSpec CodeSpec Source # 
Instance details

Defined in Language.Drasil.CodeSpec

Methods

codeSpec :: Lens' CodeSpec CodeSpec Source #

cMap :: Lens' CodeSpec ConstraintCEMap Source #

configFiles :: Lens' CodeSpec [RelativeFile] Source #

constDefns :: Lens' CodeSpec [Const] Source #

constMap :: Lens' CodeSpec ConstantMap Source #

csSysMeta :: Lens' CodeSpec SystemMeta Source #

derivedInputs :: Lens' CodeSpec [Derived] Source #

execOrder :: Lens' CodeSpec [Def] Source #

extInputs :: Lens' CodeSpec [Input] Source #

inputs :: Lens' CodeSpec [Input] Source #

mods :: Lens' CodeSpec [Mod] Source #

outputs :: Lens' CodeSpec [Output] Source #

Constructors

mkCodeSpec :: SmithEtAlSRS -> Choices -> CodeSpec Source #

Creates a CodeSpec using the provided System, Choices, and Mods.

ODEs

getODE :: [ExtLib] -> Maybe ODE Source #

Get ODE from ExtLib

mapODE :: Maybe ODE -> [CodeDefinition] Source #

Maps ODE to their respective CodeDefinition.

Hacks

asVC :: Func -> DefinedQuantityDict Source #

Convert a Func to an implementation-stage DefinedQuantityDict representing the function.

funcUID :: Func -> UID Source #

Get a UID of a chunk corresponding to a Func.

getDerivedInputs :: [DataDefinition] -> [Input] -> [Const] -> ChunkDB -> [SimpleQDef] Source #

Determines the derived inputs, which can be immediately calculated from the knowns (inputs and constants). If there are DDs, the derived inputs will come from those. If there are none, then the QDefinitions are used instead.

getConstraints :: HasUID c => ConstraintCEMap -> [c] -> [ConstraintCE] Source #

Get a list of Constraints for a list of CodeChunks.

constraintvars :: ConstraintCE -> ChunkDB -> [CodeVarChunk] Source #

Get a list of CodeVarChunks from a constraint.