Standardise factories #1842
Merged
Standardise factories #1842
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Take Options, return unique_ptr
Breaking change
Allows customisation of StandardFactory without lots of boilerplate
We need to include the derived-class headers in some "used" source file so that the linker doesn't remove the "unused" registration names. Given that the factories are now so short that they mostly don't need .cxx files, this removes the need for the silly getDefaultType being a function rather than constexpr value
Also: - renamed to InvertParFactory to be in line with other factories - moved into invert_parderiv header
Not a particularly elegant solution, but ensureRegistered can be defined by derived factories if the base class implementation file is small/empty. Even having even an empty function in the .cxx file causes the linker to keep all the symbols in that TU. Calling ensureRegistered in the factory getInstance means everything (should) get registered before the first time it is required.
Hangover from previous iteration
Just name the class directly
* next: (46 commits) Fixed assignment operators in PETSc interface Update googletest and mpark.variant submodules Applied clang-format to changes made in petsc_interface branch Made initialiseTest() method public in PETSc indexer unit tests Fixed bug setting yup/ydown values in PetscMatrix Added new regions to mesh for use in PETSc interface Automatied initialising of GlobalIndexer objects in PETSc interface Added PETSc interface method to permit partial assembly of matrices Small changes and refactoring to PETSc interface Fix typo in initialisation of rgn_outer_x Use lastX() check instead of firstX() when initialising rgn_outer_x Applied clang-format to changes made on the petsc_interface branch Applied clang-format to the new files added for the PETSc interface Eliminated some data races from PETSc interface tests Tidied up casting variable to BoutReal and declaration of for loops Modified PETSc interface to be thread-safe Added PETSc interface files to CMakeLists.txt PETSc interface out-of-bounds tests only run for CHECKLEVEL >= 1 Moved include of petscconf.h to within #ifdef BOUT_HAS_PETSC Made some PETSc interface tests conditional on using debug version Improved tracking of PetscMatrix::Element.value in += operator ...
ZedThree
added
the
breaking change
* next: Add invert_laplace removal to list of breaking changes Use new Options API in Laplacian ctor Remove deprecated Laplacian APIs Remove old invert_laplace interface from test-laplace Replace gyroPade* overloads with default arguments Remove deprecated overloads of gyro-average operators
|
I was also tempted to move all the factory classes into the corresponding base type and call them |
bendudson
reviewed
Nov 21, 2019
bendudson
reviewed
Nov 21, 2019
bendudson
reviewed
Nov 21, 2019
bendudson
approved these changes
Nov 21, 2019
|
There is some documentation in the docstring for the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Sorry, this is a horrible PR to drop on a Friday afternoon! On the plus side, it's net negative lines!
Standardises almost all of the various type factories, with the exception of the boundaries and DataFormat, both of which require a fair bit of special handling, not to mention I'm hoping we'll get to rewrite them completely in the near future.
All type factories now return
std::unique_ptr<BaseType>, with the exception ofMesh::create, because makingbout::globals::meshbe aunique_ptrwould break more things than I'm willing to fix just yet.Standardising all the factories like this means it's now possible to register new anything at runtime. This should allow users to experiment with their own
Solver,Laplacianor evenMesh, without needing to recompile the framework.I've provided
bin/bout-v5-factory-upgrader.pywhich takes a list of files and provides fixes to use the new APIs. It spits out diffs and gives the option to fix each file automatically. It's possible to also dump the output to a patch file, or just shut up and fix everything.Also adds command line options to just print out a list of available options for various factories. Useful to see what
Solvers orLaplacians are available. Less usefully, you can also see whatMeshis available (it's"bout").