Skip to content

Commit 632b4fb

Browse files
fsimonisfsimonis
committed
Rename isGradientDataRequired to requiresGradientDataFor
1 parent f45776b commit 632b4fb

File tree

18 files changed

+53
-52
lines changed

18 files changed

+53
-52
lines changed

‎docs/changelog/1487.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22
- Removed `precice::constants` from the C++ API and the C and Fortran bindings.
33
- Added `precicef_get_version_information_` to Fortran bindings.
44
- Renamed `isMeshConnectivityRequired()` to `requiresMeshConnectivityFor()`
5+
- Renamed `isGradientDataRequired()` to `requiresGradientDataFor()`

‎extras/bindings/c/include/precice/SolverInterfaceC.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -449,8 +449,8 @@ PRECICE_API const char *precicec_getVersionInformation();
449449
*/
450450
///@{
451451

452-
/// @copydoc precice::SolverInterface::isGradientDataRequired
453-
PRECICE_API int precicec_isGradientDataRequired(int dataID);
452+
/// @copydoc precice::SolverInterface::requiresGradientDataFor
453+
PRECICE_API int precicec_requiresGradientDataFor(int dataID);
454454

455455
/// @copydoc precice::SolverInterface::writeScalarGradientData
456456
PRECICE_API void precicec_writeScalarGradientData(

‎extras/bindings/c/src/SolverInterfaceC.cpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -358,10 +358,10 @@ void precicec_readScalarData(
358358
impl->readScalarData(dataID, valueIndex, *dataValue);
359359
}
360360

361-
int precicec_isGradientDataRequired(int dataID)
361+
int precicec_requiresGradientDataFor(int dataID)
362362
{
363363
PRECICE_CHECK(impl != nullptr, errormsg);
364-
if (impl->isGradientDataRequired(dataID)) {
364+
if (impl->requiresGradientDataFor(dataID)) {
365365
return 1;
366366
}
367367
return 0;

‎extras/bindings/fortran/include/precice/SolverInterfaceFortran.hpp‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -664,16 +664,16 @@ PRECICE_API void precicef_get_version_information_(
664664

665665
/**
666666
* Fortran syntax:
667-
* precicef_is_gradient_data_required_(
667+
* precicef_requires_gradient_data_for_(
668668
* INTEGER dataID,
669669
* INTEGER required )
670670
*
671671
* IN: dataID
672672
* OUT: required(1:true, 0:false)
673673
*
674-
* @copydoc precice::SolverInterface::isGradientDataRequired
674+
* @copydoc precice::SolverInterface::requiresGradientDataFor
675675
*/
676-
PRECICE_API void precicef_is_gradient_data_required_(const int *dataID, int *required);
676+
PRECICE_API void precicef_requires_gradient_data_for_(const int *dataID, int *required);
677677

678678
/**
679679
* Fortran syntax:

‎extras/bindings/fortran/src/SolverInterfaceFortran.cpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -439,10 +439,10 @@ void precicef_get_mesh_vertices_and_IDs_(
439439
impl->getMeshVerticesAndIDs(meshID, size, ids, coordinates);
440440
}
441441

442-
void precicef_is_gradient_data_required_(const int *dataID, int *required)
442+
void precicef_requires_gradient_data_for_(const int *dataID, int *required)
443443
{
444444
PRECICE_CHECK(impl != nullptr, errormsg);
445-
if (impl->isGradientDataRequired(*dataID)) {
445+
if (impl->requiresGradientDataFor(*dataID)) {
446446
*required = 1;
447447
} else {
448448
*required = 0;

‎src/precice/SolverInterface.cpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,9 @@ bool SolverInterface::requiresMeshConnectivityFor(int meshID) const
9494
return _impl->requiresMeshConnectivityFor(meshID);
9595
}
9696

97-
bool SolverInterface::isGradientDataRequired(int dataID) const
97+
bool SolverInterface::requiresGradientDataFor(int dataID) const
9898
{
99-
return _impl->isGradientDataRequired(dataID);
99+
return _impl->requiresGradientDataFor(dataID);
100100
}
101101

102102
bool SolverInterface::hasData(

‎src/precice/SolverInterface.hpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1072,7 +1072,7 @@ class PRECICE_API SolverInterface {
10721072
* @param[in] dataID the id of the data
10731073
* @returns whether gradient is required
10741074
*/
1075-
bool isGradientDataRequired(int dataID) const;
1075+
bool requiresGradientDataFor(int dataID) const;
10761076

10771077
/**
10781078
* @brief Writes vector gradient data given as block.

‎src/precice/impl/SolverInterfaceImpl.cpp‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -618,7 +618,7 @@ bool SolverInterfaceImpl::requiresMeshConnectivityFor(int meshID) const
618618
return context.meshRequirement == mapping::Mapping::MeshRequirement::FULL;
619619
}
620620

621-
bool SolverInterfaceImpl::isGradientDataRequired(int dataID) const
621+
bool SolverInterfaceImpl::requiresGradientDataFor(int dataID) const
622622
{
623623
PRECICE_VALIDATE_DATA_ID(dataID);
624624
// Read data never requires gradients
@@ -1102,7 +1102,7 @@ void SolverInterfaceImpl::writeScalarGradientData(
11021102
PRECICE_CHECK(_state != State::Finalized, "writeScalarGradientData(...) cannot be called after finalize().")
11031103
PRECICE_REQUIRE_DATA_WRITE(dataID);
11041104

1105-
if (isGradientDataRequired(dataID)) {
1105+
if (requiresGradientDataFor(dataID)) {
11061106
PRECICE_DEBUG("Gradient value = {}", Eigen::Map<const Eigen::VectorXd>(gradientValues, _dimensions).format(utils::eigenio::debug()));
11071107
PRECICE_CHECK(gradientValues != nullptr, "writeScalarGradientData() was called with gradientValues == nullptr");
11081108

@@ -1161,7 +1161,7 @@ void SolverInterfaceImpl::writeBlockScalarGradientData(
11611161
if (size == 0)
11621162
return;
11631163

1164-
if (isGradientDataRequired(dataID)) {
1164+
if (requiresGradientDataFor(dataID)) {
11651165

11661166
PRECICE_CHECK(valueIndices != nullptr, "writeBlockScalarGradientData() was called with valueIndices == nullptr");
11671167
PRECICE_CHECK(gradientValues != nullptr, "writeBlockScalarGradientData() was called with gradientValues == nullptr");
@@ -1209,7 +1209,7 @@ void SolverInterfaceImpl::writeVectorGradientData(
12091209
PRECICE_CHECK(_state != State::Finalized, "writeVectorGradientData(...) cannot be called after finalize().")
12101210
PRECICE_REQUIRE_DATA_WRITE(dataID);
12111211

1212-
if (isGradientDataRequired(dataID)) {
1212+
if (requiresGradientDataFor(dataID)) {
12131213

12141214
PRECICE_CHECK(gradientValues != nullptr, "writeVectorGradientData() was called with gradientValue == nullptr");
12151215

@@ -1259,7 +1259,7 @@ void SolverInterfaceImpl::writeBlockVectorGradientData(
12591259
if (size == 0)
12601260
return;
12611261

1262-
if (isGradientDataRequired(dataID)) {
1262+
if (requiresGradientDataFor(dataID)) {
12631263

12641264
PRECICE_CHECK(valueIndices != nullptr, "writeBlockVectorGradientData() was called with valueIndices == nullptr");
12651265
PRECICE_CHECK(gradientValues != nullptr, "writeBlockVectorGradientData() was called with gradientValues == nullptr");

‎src/precice/impl/SolverInterfaceImpl.hpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,8 +147,8 @@ class SolverInterfaceImpl {
147147
/// @copydoc SolverInterface::requiresMeshConnectivityFor
148148
bool requiresMeshConnectivityFor(int meshID) const;
149149

150-
/// @copydoc SolverInterface::isGradientDataRequired
151-
bool isGradientDataRequired(int dataID) const;
150+
/// @copydoc SolverInterface::requiresGradientDataFor
151+
bool requiresGradientDataFor(int dataID) const;
152152

153153
/// @copydoc SolverInterface::setMeshVertex
154154
int setMeshVertex(

‎tests/parallel/mapping-nearest-neighbor-gradient/GradientTestParallelScalar.cpp‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ BOOST_AUTO_TEST_CASE(GradientTestParallelScalar)
5252
double positions[4] = {xCoord, 0.0, xCoord + 0.2, 0.0};
5353
interface.setMeshVertices(meshID, 2, positions, vertexIDs);
5454
interface.initialize();
55-
BOOST_TEST(interface.isGradientDataRequired(dataID) == false);
55+
BOOST_TEST(interface.requiresGradientDataFor(dataID) == false);
5656
Eigen::Vector2d values;
5757
interface.advance(1.0);
5858
interface.readBlockScalarData(dataID, 2, vertexIDs, values.data());
@@ -68,12 +68,12 @@ BOOST_AUTO_TEST_CASE(GradientTestParallelScalar)
6868
interface.setMeshVertices(meshID, 6, positions, vertexIDs);
6969
interface.initialize();
7070
int dataID = interface.getDataID("Data2", meshID);
71-
BOOST_TEST(interface.isGradientDataRequired(dataID));
71+
BOOST_TEST(interface.requiresGradientDataFor(dataID));
7272
double values[6] = {1.0, 2.0, 3.0, 4.0, 5.0, 6.0};
7373

7474
interface.writeBlockScalarData(dataID, 6, vertexIDs, values);
7575

76-
if (interface.isGradientDataRequired(dataID)) {
76+
if (interface.requiresGradientDataFor(dataID)) {
7777

7878
double gradientValues[12] = {1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0};
7979
interface.writeBlockScalarGradientData(dataID, 6, vertexIDs, gradientValues);

0 commit comments

Comments
 (0)