import ModelDescription from 'Artistoo/src/converter/ModelDescription.js'
public class | source

ModelDescription

Direct Subclass:

ArtistooImport, MorpheusImport
this class is experimental.

This class is meant as a bridge to convert between model frameworks. It currently supports only conversion from Artistoo -> Morpheus and vice versa.

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

cellKinds: {"name2index": *, "index2name": *, "properties": *, "count": *}

public

constraints: {"constraints": *}

public

conversionWarnings: {"modelInfo": *, "grid": *, "time": *, "cells": *, "kinetics": *, "constraints": *, "init": *, "analysis": *}

public
public

grid: {"geometry": *, "ndim": *, "extents": *, "boundaries": *, "neighborhood": *}

public

kinetics: {"T": *, "seed": *}

public

modelInfo: {"title": *, "desc": *}

public

setup: {"init": *}

public

timeInfo: {"start": *, "stop": *, "duration": *}

Method Summary

Public Methods
public

addConstraint(name: *, conf: *)

public

build()

public
public

getConstraint(name: *, index: number): *

public

getConstraintParameter(constraintName: *, paramName: *, index: number): *

public

getKindIndex(kindName: *): *

public

getKindName(kindIndex: *): *

public

hasConstraint(name: *): *

public

initCellKindMatrix(value: *, includeBackground: boolean): *

public

initCellKindVector(value: *, includeBackground: boolean): *

public

initDimensionVector(value: *): *

public
public
public
public
public
public

setGridGeometry(geomString: *)

public
public
public

Public Constructors

public constructor() source

Public Members

public cellKinds: {"name2index": *, "index2name": *, "properties": *, "count": *} source

public constraints: {"constraints": *} source

public conversionWarnings: {"modelInfo": *, "grid": *, "time": *, "cells": *, "kinetics": *, "constraints": *, "init": *, "analysis": *} source

public generalWarning: string source

public grid: {"geometry": *, "ndim": *, "extents": *, "boundaries": *, "neighborhood": *} source

public kinetics: {"T": *, "seed": *} source

public modelInfo: {"title": *, "desc": *} source

public setup: {"init": *} source

public timeInfo: {"start": *, "stop": *, "duration": *} source

Public Methods

public addConstraint(name: *, conf: *) source

Params:

NameTypeAttributeDescription
name *
conf *

public build() source

public callerName(): string source

Return:

string

public getConstraint(name: *, index: number): * source

Params:

NameTypeAttributeDescription
name *
index number
  • optional
  • default: 0

Return:

*

public getConstraintParameter(constraintName: *, paramName: *, index: number): * source

Params:

NameTypeAttributeDescription
constraintName *
paramName *
index number
  • optional
  • default: 0

Return:

*

public getKindIndex(kindName: *): * source

Params:

NameTypeAttributeDescription
kindName *

Return:

*

public getKindName(kindIndex: *): * source

Params:

NameTypeAttributeDescription
kindIndex *

Return:

*

public hasConstraint(name: *): * source

Params:

NameTypeAttributeDescription
name *

Return:

*

public initCellKindMatrix(value: *, includeBackground: boolean): * source

Params:

NameTypeAttributeDescription
value *
  • optional
  • default: NaN
includeBackground boolean
  • optional
  • default: true

Return:

*

public initCellKindVector(value: *, includeBackground: boolean): * source

Params:

NameTypeAttributeDescription
value *
  • optional
  • default: NaN
includeBackground boolean
  • optional
  • default: true

Return:

*

public initDimensionVector(value: *): * source

Params:

NameTypeAttributeDescription
value *
  • optional
  • default: NaN

Return:

*

public methodOverwriteError() source

public setCPMGeneral() source

public setCellKindNames() source

public setConstraints() source

public setGridConfiguration() source

public setGridGeometry(geomString: *) source

Params:

NameTypeAttributeDescription
geomString *

public setGridInfo() source

public setModelInfo() source

public setTimeInfo() source