Skip to contents

This function creates an Omega instance with the given parameters and validates it.

Usage

Omega(
  Name = character(),
  InitialOmega = 1,
  State = "Present",
  Frozen = FALSE,
  StParmName = character(),
  PMLStructure = character()
)

Arguments

Name

A character string specifying the name of the Omega.

InitialOmega

Numeric specifying the initial value of the Omega. Default value is 1.

State

Character specifying the presence of the Omega. Possible values are:

  • None The Omega does not exist in the specified PMLStructures.

  • Present The Omega exists in the specified PMLStructures (the default).

  • Searched The presence of the Omega is searched.

Frozen

A logical value indicating whether the Omega is frozen or not.

StParmName

A character string specifying the corresponding structural parameter name.

PMLStructure

PML structure current omega belongs to.

Value

An Omega instance.

See also

list_Omegas()

Functions used for Omega specification: create_ModelPD(), create_ModelPK(), modify_Omega()

Examples

nV <- Omega("nV")