Skip to content

Commit 448d4ca

Browse files
committed
Merge remote-tracking branch 'origin/master' into chmerdon/some_documentation_fixes
# Conflicts: # src/feevaluator.jl # src/point_evaluator.jl
2 parents de32002 + 2c88ed8 commit 448d4ca

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

src/point_evaluator.jl

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,20 @@ This function prepares the `PointEvaluator` for evaluation by associating it wit
9494
- `time`: (default: `0`) Time value to be passed to the quadrature point info structure.
9595
$(_myprint(default_peval_kwargs()))
9696
97+
# Notes
98+
- This function must be called before using `evaluate!` or `evaluate_bary!` with the `PointEvaluator`.
99+
Initializes the given `PointEvaluator` for a specified solution (FEVector or vector of FEVectorBlocks).
100+
101+
This function prepares the `PointEvaluator` for evaluation by associating it with the provided solution vector. It sets up the necessary finite element basis evaluators, local-to-global transformations, and cell finder structures for the underlying grid.
102+
103+
# Arguments
104+
- `O::PointEvaluator`: The `PointEvaluator` instance to initialize.
105+
- `sol`: The solution object (e.g., array of FEVectorBlocks) to be used for evaluations.
106+
107+
# Keyword Arguments
108+
- `time`: (default: `0`) Time value to be passed to the quadrature point info structure.
109+
$(_myprint(default_peval_kwargs()))
110+
97111
# Notes
98112
- This function must be called before using `evaluate!` or `evaluate_bary!` with the `PointEvaluator`.
99113
"""

0 commit comments

Comments
 (0)