The Initialize_Monomial procedure allocates and initializes a Monomial object.
Calling syntax:
| call Initialize (Monomial, Coefficient, Exponent, Phi_MV, Locus, Mesh, Name, status) |
Input variables:
| Subtype variables | |||
| Monomial | The Monomial object to be initialized. | ||
| Coefficient | A vector of coefficents for the monomial. | ||
| Exponent | The degree (exponent) of the monomial. | ||
| Phi_MV | An Mathematic Vector of the independent variable that this monomial is based on (past time step or iterate value). | ||
| Locus | The location for the monomial (e.g. Cells, Nodes or Faces) | ||
| Mesh | The Mesh object that this monomial is based on. | ||
| Name | The name for this variable. [Optional] | ||
Output variables:
| Monomial | The Monomial object has been allocated and initialized. | ||
| status | If present, the status variable is set to either 'Memory Error' or 'Success' depending on program execution. If not present, the procedure aborts if unsuccessful when the DEBUG_LEVEL is set high enough. |
Internal variables:
| allocate_status | Allocation Status. | ||
| consolidated_status | Consolidated Status. |
The Initialize_Monomial code listing contains additional documentation.
Michael L. Hall