Draft: fix-Removing duplicate function GetMetricInfo
Issue/feature addressed
In library/SpatialDomain/Geometry.h there are two functions defined which are exactly the same with different names. The first is GetGeomFactors and the second is GetMetricInfo. Both were used interchangeably and such unnecessary duplication introduced inconsistency in naming across the code. for example in some places the member function is defined as m_geomFactors and in some m_metricInfo
Proposed solution
Removed the GetMetricInfo function and replaced it with GetGeomFactors. Similar for m_metricInfo which is replaced by m_geomFactors The reason that GetGeomFactors is used, aside from its origins in Geometry, is that there is a GetRefGeomFactors function in Geometry.h that is consistent with GetGeomFactors and using this name will reduce the number of changes. Otherwise, the GetRefGeomFactors should be renamed to GetRefMetricInfo for naming consistency and to revise the code accordingly.
Implementation
Tests
No need
Notes
Please add any other information that could be useful for reviewers.
Checklist
-
Functions and classes, or changes to them, are documented. -
User guide/documentation is updated. -
Changelog is updated. -
Suitable tests added for new functionality. -
Contributed code is correctly formatted. (See the contributing guidelines). -
License added to any new files. -
No extraneous files have been added (e.g. compiler output or test data files).
Warning
On the 19.07 the code formatting (code style) was standardised using clang-format, over the whole Nektar++ code. This means changes in your branch will conflict with formatting changes on the master branch. To resolve these conflicts , see
#295 (closed)