Detailed Description
Abstract fit constraint.
Inheritance diagram for fit_constraint:
Public Member Functions | |
| procedure | error (self, gs) |
| Compute error. | |
| procedure | eval (self, gs) |
| Evaluate constraint value. | |
| procedure | get_nax (self, gs) |
| Get non-axisymmetric correction. | |
| procedure | is_parallel (self) |
| Does constraint use parallelism in calculation? | |
| procedure | setup_comp (self) |
| Setup 3D error field compensation information. | |
Public Attributes | |
| real(8), dimension(:,:), pointer | comp_n => NULL() |
| Compensation unit normal. | |
| real(8), dimension(:,:), pointer | comp_r => NULL() |
| Compensation location. | |
| real(8), dimension(:), pointer | nax_corr => NULL() |
| Non-axisymmetric compensations. | |
| integer(4) | ncomp = 0 |
| Number of non-axisymmetric compensations. | |
| real(8) | val = 0.d0 |
| Constraint value. | |
| real(8) | wt = 1.d0 |
| Constraint weight. | |
Member Function/Subroutine Documentation
◆ error()
| procedure error | ( | class(fit_constraint), intent(inout) | self, |
| type(gs_eq), intent(inout) | gs | ||
| ) |
Compute error.
- Parameters
-
[in,out] self Needs docs [in,out] gs Needs docs
- Returns
- Needs docs
◆ eval()
| procedure eval | ( | class(fit_constraint), intent(inout) | self, |
| type(gs_eq), intent(inout) | gs | ||
| ) |
Evaluate constraint value.
- Parameters
-
[in,out] self Needs docs [in,out] gs Needs docs
- Returns
- Needs docs
◆ get_nax()
| procedure get_nax | ( | class(fit_constraint), intent(inout) | self, |
| type(gs_eq), intent(inout) | gs | ||
| ) |
Get non-axisymmetric correction.
- Parameters
-
[in,out] self Needs docs [in,out] gs Needs docs
- Returns
- Needs docs
◆ is_parallel()
| procedure is_parallel | ( | class(fit_constraint), intent(inout) | self | ) |
Does constraint use parallelism in calculation?
- Parameters
-
[in,out] self Needs docs
- Returns
- Needs docs
◆ setup_comp()
| procedure setup_comp | ( | class(fit_constraint), intent(inout) | self | ) |
Setup 3D error field compensation information.
- Parameters
-
[in,out] self Needs docs
Member Data Documentation
◆ comp_n
| real(8), dimension(:,:), pointer comp_n => NULL() |
Compensation unit normal.
◆ comp_r
| real(8), dimension(:,:), pointer comp_r => NULL() |
Compensation location.
◆ nax_corr
| real(8), dimension(:), pointer nax_corr => NULL() |
Non-axisymmetric compensations.
◆ ncomp
| integer(4) ncomp = 0 |
Number of non-axisymmetric compensations.
◆ val
| real(8) val = 0.d0 |
Constraint value.
◆ wt
| real(8) wt = 1.d0 |
Constraint weight.
The documentation for this type was generated from the following file:
- /home/runner/work/OpenFUSIONToolkit/OpenFUSIONToolkit/src/physics/grad_shaf_fit.F90
