[DEFECT] User Manual Incorrect Description of Constraints for Genetic Algorithm Optimizer

[sprapp-inl]

Thank you for the defect report

• I am using the latest version of RAVEN.
• I have read the Wiki.
• I have created a minimum, reproducible example
  that demonstrates the defect.

EDIT

This problem has been documented before (see #2053)

Defect Description

What did you see?

RAVEN User Manual (rev. 10) has completely incorrect descriptions for the <Constraint> and <ImplicitConstraint> function required formats for the <GeneticAlgorithm> optimizer (Section 11.3).

Steps to Reproduce

As of current version, this description of <Constraint> and <ImplicitConstraint> for the Genetic Algorithm optimizer are incorrectly documented in the manual. Go to manual section 11.3, page 209.

Expected Behavior

RAVEN User Manual (rev. 10) to have correct description of <Constraint> and <ImplicitConstraint> functions of the <GeneticAlgorithm> optimizer (Section 11.3).

Do you have a suggested fix for the development team?

Update description based on how constraint functions are actually handled for the Genetic Algorithm, and include a section in the <fitness> section indicating how the constraint is applied in relation to the fitness function and related coefficients of constraint penalty.

([TASK]?) In addition, it may be worth raising an Exception when a constraint function does not follow the proper syntax, and, as an extension, raise a Warning if a constraint function has no effect (i.e. if input space is already completely within constraint)

Relevant Documentation and Files

RAVEN User Manual (Rev. 10):

• raven_user_manual.pdf

Python file with methods for fitness evaluation from Genetic Algorithm optimizer:

• https://github.com/idaholab/raven/blob/3c6e05339688f7590d154d37580c56e0408ba3c3/ravenframework/Optimizers/fitness/fitness.py

Example of how GeneticAlgorithm constraints should be formatted (from workshop documentation and examples):

• Constraint: https://github.com/idaholab/raven/blob/3c6e05339688f7590d154d37580c56e0408ba3c3/doc/workshop/optimizer/GeneticAlgorithms/Inputs/myConstraints.py
• RAVEN Input File with constrained GeneticAlgorithm optimizer: https://github.com/idaholab/raven/blob/3c6e05339688f7590d154d37580c56e0408ba3c3/doc/workshop/optimizer/GeneticAlgorithms/Inputs/3_GA_MaxwoRepConstrained.xml

OS

Linux

OS Version

No response

Dependency Manager

CONDA

For Change Control Board: Issue Review

• Is it tagged with a type: defect or task?
• Is it tagged with a priority: critical, normal or minor?
• If it will impact requirements or requirements tests, is it tagged with requirements?
• If it is a defect, can it cause wrong results for users? If so an email needs to be sent to the users.
• Is a rationale provided? (Such as explaining why the improvement is needed or why current code is wrong.)

For Change Control Board: Issue Closure

• If the issue is a defect, is the defect fixed?
• If the issue is a defect, is the defect tested for in the regression test system? (If not explain why not.)
• If the issue can impact users, has an email to the users group been written (the email should specify if the defect impacts stable or master)?
• If the issue is a defect, does it impact the latest release branch? If yes, is there any issue tagged with release (create if needed)?
• If the issue is being closed without a pull request, has an explanation of why it is being closed been provided?