gradient
The gradient module calculates the vector gradient field of a scalar data component at every node in a mesh. Input must contain a mesh of any type and nodal data with at least one scalar data component. The module uses a finite-difference method based on central differencing to calculate the gradient on structured (rectilinear) meshes, and shape functions with their derivatives for unstructured meshes. Both nodal and cell data components can be used as the gradient source.
Note that the gradient of (pressure) head points in the direction of increasing head, not the direction that groundwater would flow. See the seepage velocity module if you wish to compute groundwater flow.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Field | Field | The field containing data used to calculate gradient. |
| Input | Z Scale | Number | The factor for vertical scaling. |
| Output | Output Field | Field | A field containing the gradient data. |
| Output | Output Object | Renderable | A renderable object displaying the gradient data. |
Properties
| Property | Type | Description |
|---|---|---|
| Z Scale | Double | The Z Scale is required to ensure that the output gradients are matched to scaled input. |
| Gradient By | Choice: Nodal Data, Cell Data | Selects the type of data to use to calculate gradients. |
| Nodal Gradient Component | Choice | The scalar nodal data component to be used by gradient. The data component selected must be scalar or an error will occur. Only enabled when Gradient By is set to Nodal Data. |
| Cell Gradient Component | Choice | The scalar cell data component to be used by gradient. The data component selected must be scalar or an error will occur. Only enabled when Gradient By is set to Cell Data. |