gp.force.app
Syntax
- v := gp.force.app(gp)
Get the total applied force at a gridpoint. This includes all sources, including forces due to gravity.
Returns: v - total applied force vector Arguments: z - zone pointer
Component Access
f := gp.force.app
(gp)->x
- f := gp.force.app.x(gp)
Get the \(x\)-component of the total applied force at a gridpoint.
Returns: f - \(x\)-component of the total applied force vector Arguments: gp - zone pointer
Access other vector components (\(y\), \(z\)) by substituting the component name where \(x\) appears above. See Member Access Operator for information about accessing members from data types using ->
.
Deprecated Component Access
Component access by adding an optional integer in the function arguments (gp.force.app(gp,<int>)
) is deprecated. It remains available but will not be supported in future versions. See Component Access with Integers in FISH on the Deprecated Commands and FISH page for details.
Was this helpful? ... | PFC © 2021, Itasca | Updated: Feb 25, 2024 |