New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make interfaces const-correct and use more detailed errors with paramError() #17512

Open

4 tasks

loganharbour opened this issue Apr 5, 2021 · 0 comments

Labels

C: Framework P: normal T: task

Member

loganharbour commented Apr 5, 2021 •

edited

Reason

I've found quite a few interfaces that aren't const-correct that should be cleaned up (list is still a WIP):

UserObjectInterface
PostprocessorInterface
VectorPostprocessorInterface
ReporterInterface

Design

Make these interfaces as const-correct as possible and improve error handling with paramError() where possible.

Impact

Const-correct code is better code, and more detailed errors are better for the end user. May disrupt a few applications with the need to make more methods const, but it's worth it.

loganharbour added T: task P: normal labels

loganharbour mentioned this issue

Improve UserObjectInterface errors #17496

Merged

loganharbour added the C: Framework label

loganharbour added a commit to aprilnovak/moose that referenced this issue


          Add error checking to UserObjectInterface and make more things const

957b4e7

Co-authored-by: April Novak <novak@berkeley.edu>

refs idaholab#17446 and idaholab#17512

loganharbour changed the title ~~Interfaces need to be const-correct~~ Make interfaces const-correct and use more detailed errors with paramError()

loganharbour added a commit to aprilnovak/moose that referenced this issue


          Add error checking to UserObjectInterface and make more things const

ddd9eb4

Co-authored-by: April Novak <novak@berkeley.edu>

refs idaholab#17446 and idaholab#17512

loganharbour added a commit to aprilnovak/moose that referenced this issue


          Move threaded copy designator to UserObject

refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Improve PostprocessorInterface

84077c9

- Make const-correct where possible
- Use the related object's paramError and mooseError where possible
- Make Reporter more const-correct without the need for a write key
  for the PostprocessorInterface
- Improve the checking of the existance of a postprocessor

Refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Move UserObject methods to source/bottom of header

f58217c

refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Make interface methods that are overridden virtual

635dc61

refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Use UserObjectInterface methods with error checking

438063d

refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Improve PostprocessorInterface

14c0e00

- Make const-correct where possible
- Use the related object's paramError and mooseError where possible
- Make Reporter more const-correct without the need for a write key
  for the PostprocessorInterface
- Improve the checking of the existance of a postprocessor

Refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Move UserObject methods to source/bottom of header

6f0d1c3

refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Make interface methods that are overridden virtual

3908f67

refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Use UserObjectInterface methods with error checking

23d9924

refs idaholab#17512

loganharbour mentioned this issue

Various (many...) interface and Reporter enhancements #17527

Merged

loganharbour added a commit to loganharbour/moose that referenced this issue


          Improve PostprocessorInterface

e8f1494

- Make const-correct where possible
- Use the related object's paramError and mooseError where possible
- Make Reporter more const-correct without the need for a write key
  for the PostprocessorInterface
- Improve the checking of the existance of a postprocessor

Refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Move UserObject methods to source/bottom of header

2a4c0d9

refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Make interface methods that are overridden virtual

94b9367

refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Use UserObjectInterface methods with error checking

804d87e

refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Improve PostprocessorInterface

6b8bedf

- Make const-correct where possible
- Use the related object's paramError and mooseError where possible
- Make Reporter more const-correct without the need for a write key
  for the PostprocessorInterface
- Improve the checking of the existance of a postprocessor

Refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Move UserObject methods to source/bottom of header

d732950

refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Make interface methods that are overridden virtual

039b121

refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Use UserObjectInterface methods with error checking

4040c34

refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Add tests for PostprocessorInterface errors

58c9bd6

refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Improve PostprocessorInterface

4e20168

- Make const-correct where possible
- Use the related object's paramError and mooseError where possible
- Make Reporter more const-correct without the need for a write key
  for the PostprocessorInterface
- Improve the checking of the existance of a postprocessor

Refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Move UserObject methods to source/bottom of header

861b3c5

refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Make interface methods that are overridden virtual

8afabeb

refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Use UserObjectInterface methods with error checking

1781e9c

refs idaholab#17512

loganharbour mentioned this issue

Remove unused initPostprocessorData() #17973

Merged

aeslaughter pushed a commit to aeslaughter/moose that referenced this issue


          Add error checking to UserObjectInterface and make more things const

2022a2f

Co-authored-by: April Novak <novak@berkeley.edu>

refs idaholab#17446 and idaholab#17512

aeslaughter pushed a commit to aeslaughter/moose that referenced this issue


          Move threaded copy designator to UserObject

0bfd5f6

refs idaholab#17512

aeslaughter pushed a commit to aeslaughter/moose that referenced this issue


          Improve PostprocessorInterface

e421eed

- Make const-correct where possible
- Use the related object's paramError and mooseError where possible
- Make Reporter more const-correct without the need for a write key
  for the PostprocessorInterface
- Improve the checking of the existance of a postprocessor
- Remove metadata store for postprocessors in InputParameters/Parser
  and instead check on the fly

Refs idaholab#17512

aeslaughter pushed a commit to aeslaughter/moose that referenced this issue


          Move UserObject methods to source/bottom of header

20ffe49

refs idaholab#17512

aeslaughter pushed a commit to aeslaughter/moose that referenced this issue


          Make interface methods that are overridden virtual

2b4fa9c

refs idaholab#17512

aeslaughter pushed a commit to aeslaughter/moose that referenced this issue


          Use UserObjectInterface methods with error checking

2b79048

refs idaholab#17512

aeslaughter pushed a commit to aeslaughter/moose that referenced this issue


          Add tests for PostprocessorInterface errors

d63b7f8

refs idaholab#17512

aeslaughter pushed a commit to aeslaughter/moose that referenced this issue


          Make sure function signatures are consistent

86c4b2d

refs idaholab#17512

aeslaughter pushed a commit to aeslaughter/moose that referenced this issue


          Check that in the case of non-insertion that values are the same

a383656

refs idaholab#17512

aeslaughter pushed a commit to aeslaughter/moose that referenced this issue


          Remove unnecessary reporter getter in FEProblemBase

4ed1db4

refs idaholab#17512

aeslaughter pushed a commit to aeslaughter/moose that referenced this issue


          Remove unneeded hasPostprocesorObject method

0c16068

refs idaholab#17512

aeslaughter pushed a commit to aeslaughter/moose that referenced this issue


          Add extra error checking when possible, add enabled pp method

ff80c7d

refs idaholab#17512

aeslaughter pushed a commit to aeslaughter/moose that referenced this issue


          Improve VectorPostprocessorInterface

9f492be

- Use the object's mooseError() and paramError() where possible
- Improve function signatures
- Use error checking in overridden methods

refs idaholab#17512

aeslaughter pushed a commit to aeslaughter/moose that referenced this issue


          Add dependency helpers to PP, VPP, and UO interfaces

f63dc55

refs idaholab#17512

aeslaughter pushed a commit to aeslaughter/moose that referenced this issue


          Improve UserObjectInterface error testing

b7a8fb4

refs idaholab#17512

aeslaughter pushed a commit to aeslaughter/moose that referenced this issue


          Various fixups

970fc6a

refs idaholab#17512

aeslaughter pushed a commit to aeslaughter/moose that referenced this issue


          Reporter system enhancements

dc411b5

- Declare Reporter values for PPs and VPPs within the objects themselves
- Add type checking on declare/request for Reporters with the same name
- Add producer/consumer MooseObject ptrs in ReporterState
- Add getter for information about a Reporter (type, producers, consumers,
  context, modes)
- Add more error handling to ReporterData, Reporter, and ReporterInterface

refs idaholab#17512 idaholab#17605

aeslaughter pushed a commit to aeslaughter/moose that referenced this issue


          Add more tests for Reporter and ReporterInterface

ebf35b0

refs idaholab#17512 idaholab#17605

aeslaughter pushed a commit to aeslaughter/moose that referenced this issue


          Add test design/doco pages for Reporter and VPP interfaces

498da8a

refs idaholab#17605 idaholab#17512

aeslaughter pushed a commit to aeslaughter/moose that referenced this issue


          Re-add unused initPostprocessorData to be removed soon

b992038

refs idaholab#17512

aeslaughter pushed a commit to aeslaughter/moose that referenced this issue


          Clean up PP interface for default values and remove deprecated methods

d9ed02f

refs idaholab#17512 idaholab#17605

aeslaughter pushed a commit to aeslaughter/moose that referenced this issue


          Re-add deprecated param that isn't ready to go yet

5f34f6c

refs idaholab#17512

aeslaughter pushed a commit to aeslaughter/moose that referenced this issue


          Remove unused method

e643bcf

refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Remove unused initPostprocessorData()

2f9c73d

refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Remove unused initPostprocessorData()

4407fc0

refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Remove unused initPostprocessorData()

1a6edfe

refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Remove unused initPostprocessorData()

6aecef1

refs idaholab#17512

loganharbour added a commit to loganharbour/moose that referenced this issue


          Remove unused initPostprocessorData()

2837d58

refs idaholab#17512

grmnptr pushed a commit to grmnptr/moose that referenced this issue


          Remove unused initPostprocessorData()

3be23b9

refs idaholab#17512

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment