The Initialize_Ortho_Diffusion procedure allocates and initializes an Ortho_Diffusion Term object.
Calling syntax:
call Initialize (Diff_Term, Coefficient, BC_Faces_of_Cells, Phi_BC_Faces_of_Cells, Phi_MV, Locus, Mesh, Name, Extrapolation, Equation, NEquations, status) |
Input variables:
Subtype variables | |||
Diff_Term | The Ortho_Diffusion object to be initialized. | ||
BC_Faces_of_Cells | Boundary condition flags for this Ortho_Diffusion object. | ||
Phi_BC_Faces_of_Cells | Boundary condition constants for this Ortho_Diffusion object. | ||
Coefficient | A vector of diffusion coefficents. | ||
Phi_MV | An Mathematic Vector of the independent variable that this Ortho_Diffusion object is based on (past time step or iterate value). | ||
Locus | The location for the Ortho_Diffusion Term (e.g. Cells, Nodes or Faces) | ||
Mesh | The Mesh object that this Ortho_Diffusion Term is based on. | ||
Name | The name for this variable. [Optional] | ||
Extrapolation | A factor used in the source and vacuum boundary conditions, which effectively sets the extrapolation distance to Coefficient/Extrapolation. [Optional, default is 1/2] | ||
Equation | The equation number for this variable. [Optional] | ||
NEquations | The total number of equations in this system. |
Output variables:
Diff_Term | The Ortho_Diffusion 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_Ortho_Diffusion code listing contains additional documentation.
Michael L. Hall