#197: NOX: Provide Tpetra versions of LOCA_TestProblems tests

[antoinemeyer5]

WIP, fixes #197

[tlamonthezie]

WIP State

LOCA_TestProblems is a Test library providing a set of classes that are used by LOCA_UnitTests (and maybe in other tests)

The work is in in the following state:

• Translated classes : Basis
• WIP classes: FiniteElementProblem, Pitchfork_FiniteElementProblem, (LOCALinearConstraint)

We added also a NGA_DevTests to LOCA_UnitTests to test the library classes during the development of the tpetra versions of LOCA_TestProblems classes

[github-actions]

⚡ Code quality check ⚡

🔴 cppcheck found 4 issues! Click here to see details.

Trilinos/packages/nox/test/tpetra/LOCA_TestProblems/Basis.cpp

Lines 66 to 71 in f44de1c

	void Basis::getBasis(int gp, std::vector<double> x, std::vector<double> u) {
	int N = 2;
	if (gp==0) {eta=-1.0/std::sqrt(3.0); wt=1.0;}
	if (gp==1) {eta=1.0/std::sqrt(3.0); wt=1.0;}
	// Calculate basis function and derivatives at nodel pts

!Line: 66 - performance: Function parameter 'x' should be passed by const reference. [passedByValue]

Trilinos/packages/nox/test/tpetra/LOCA_TestProblems/Basis.cpp

Lines 66 to 71 in f44de1c

	void Basis::getBasis(int gp, std::vector<double> x, std::vector<double> u) {
	int N = 2;
	if (gp==0) {eta=-1.0/std::sqrt(3.0); wt=1.0;}
	if (gp==1) {eta=1.0/std::sqrt(3.0); wt=1.0;}
	// Calculate basis function and derivatives at nodel pts

!Line: 66 - performance: Function parameter 'u' should be passed by const reference. [passedByValue]

Trilinos/packages/nox/test/tpetra/LOCA_TestProblems/Basis.cpp

Lines 66 to 71 in f44de1c

	void Basis::getBasis(int gp, std::vector<double> x, std::vector<double> u) {
	int N = 2;
	if (gp==0) {eta=-1.0/std::sqrt(3.0); wt=1.0;}
	if (gp==1) {eta=1.0/std::sqrt(3.0); wt=1.0;}
	// Calculate basis function and derivatives at nodel pts

!Line: 66 - style: The function 'getBasis' is never used. [unusedFunction]

Trilinos/packages/nox/test/tpetra/LOCA_TestProblems/Pitchfork_FiniteElementProblem.cpp

Lines 55 to 60 in f44de1c

	#include "Basis.H"
	#include "NOX_Common.H"
	// Constructor - creates the Tpetra objects (maps and vectors)
	template <typename ScalarType>
	Pitchfork_FiniteElementProblem::Pitchfork_FiniteElementProblem(

!Line: 55 - information: Include file: "Basis.H" not found. [missingInclude]

---

🔴 clang-tidy found 21 issues! Click here to see details.

Trilinos/packages/nox/test/tpetra/LOCA_TestProblems/Basis.cpp

Lines 55 to 60 in f44de1c

	phi(2),
	dphide(2),
	uu(0.0),
	xx(0.0),
	duu(0.0),
	eta(0.0),

!Line: 55 - warning: calling a function that uses a default argument is disallowed [fuchsia-default-arguments-calls]

Trilinos/packages/nox/test/tpetra/LOCA_TestProblems/Basis.cpp

Lines 56 to 61 in f44de1c

	dphide(2),
	uu(0.0),
	xx(0.0),
	duu(0.0),
	eta(0.0),
	wt(0.0),

!Line: 56 - warning: calling a function that uses a default argument is disallowed [fuchsia-default-arguments-calls]

Trilinos/packages/nox/test/tpetra/LOCA_TestProblems/Basis.cpp

Lines 66 to 71 in f44de1c

	void Basis::getBasis(int gp, std::vector<double> x, std::vector<double> u) {
	int N = 2;
	if (gp==0) {eta=-1.0/std::sqrt(3.0); wt=1.0;}
	if (gp==1) {eta=1.0/std::sqrt(3.0); wt=1.0;}
	// Calculate basis function and derivatives at nodel pts

!Line: 66 - warning: parameter name 'gp' is too short, expected at least 3 characters [readability-identifier-length]

Trilinos/packages/nox/test/tpetra/LOCA_TestProblems/Basis.cpp

Lines 66 to 71 in f44de1c

	void Basis::getBasis(int gp, std::vector<double> x, std::vector<double> u) {
	int N = 2;
	if (gp==0) {eta=-1.0/std::sqrt(3.0); wt=1.0;}
	if (gp==1) {eta=1.0/std::sqrt(3.0); wt=1.0;}
	// Calculate basis function and derivatives at nodel pts

!Line: 66 - warning: 2 adjacent parameters of 'getBasis' of similar type ('std::vector<double>') are easily swapped by mistake [bugprone-easily-swappable-parameters]
!Line: 66 - note: the first parameter in the range is 'x'
!Line: 66 - note: the last parameter in the range is 'u'

Trilinos/packages/nox/test/tpetra/LOCA_TestProblems/Basis.cpp

Lines 66 to 71 in f44de1c

	void Basis::getBasis(int gp, std::vector<double> x, std::vector<double> u) {
	int N = 2;
	if (gp==0) {eta=-1.0/std::sqrt(3.0); wt=1.0;}
	if (gp==1) {eta=1.0/std::sqrt(3.0); wt=1.0;}
	// Calculate basis function and derivatives at nodel pts

!Line: 66 - warning: parameter name 'x' is too short, expected at least 3 characters [readability-identifier-length]

Trilinos/packages/nox/test/tpetra/LOCA_TestProblems/Basis.cpp

Lines 66 to 71 in f44de1c

	void Basis::getBasis(int gp, std::vector<double> x, std::vector<double> u) {
	int N = 2;
	if (gp==0) {eta=-1.0/std::sqrt(3.0); wt=1.0;}
	if (gp==1) {eta=1.0/std::sqrt(3.0); wt=1.0;}
	// Calculate basis function and derivatives at nodel pts

!Line: 66 - warning: parameter name 'u' is too short, expected at least 3 characters [readability-identifier-length]

Trilinos/packages/nox/test/tpetra/LOCA_TestProblems/Basis.cpp

Lines 67 to 72 in f44de1c

	int N = 2;
	if (gp==0) {eta=-1.0/std::sqrt(3.0); wt=1.0;}
	if (gp==1) {eta=1.0/std::sqrt(3.0); wt=1.0;}
	// Calculate basis function and derivatives at nodel pts
	phi[0]=(1.0-eta)/2.0;

!Line: 67 - warning: variable 'N' of type 'int' can be declared 'const' [misc-const-correctness]

Trilinos/packages/nox/test/tpetra/LOCA_TestProblems/Basis.cpp

Lines 67 to 72 in f44de1c

	int N = 2;
	if (gp==0) {eta=-1.0/std::sqrt(3.0); wt=1.0;}
	if (gp==1) {eta=1.0/std::sqrt(3.0); wt=1.0;}
	// Calculate basis function and derivatives at nodel pts
	phi[0]=(1.0-eta)/2.0;

!Line: 67 - warning: variable name 'N' is too short, expected at least 3 characters [readability-identifier-length]

Trilinos/packages/nox/test/tpetra/LOCA_TestProblems/Basis.cpp

Lines 68 to 73 in f44de1c

	if (gp==0) {eta=-1.0/std::sqrt(3.0); wt=1.0;}
	if (gp==1) {eta=1.0/std::sqrt(3.0); wt=1.0;}
	// Calculate basis function and derivatives at nodel pts
	phi[0]=(1.0-eta)/2.0;
	phi[1]=(1.0+eta)/2.0;

!Line: 68 - warning: 3.0 is a magic number; consider replacing it with a named constant [cppcoreguidelines-avoid-magic-numbers,readability-magic-numbers]

Trilinos/packages/nox/test/tpetra/LOCA_TestProblems/Basis.cpp

Lines 69 to 74 in f44de1c

	if (gp==1) {eta=1.0/std::sqrt(3.0); wt=1.0;}
	// Calculate basis function and derivatives at nodel pts
	phi[0]=(1.0-eta)/2.0;
	phi[1]=(1.0+eta)/2.0;
	dphide[0]=-0.5;

!Line: 69 - warning: 3.0 is a magic number; consider replacing it with a named constant [cppcoreguidelines-avoid-magic-numbers,readability-magic-numbers]

Trilinos/packages/nox/test/tpetra/LOCA_TestProblems/Basis.cpp

Lines 72 to 77 in f44de1c

	phi[0]=(1.0-eta)/2.0;
	phi[1]=(1.0+eta)/2.0;
	dphide[0]=-0.5;
	dphide[1]=0.5;
	// Caculate basis function and derivative at GP.

!Line: 72 - warning: 2.0 is a magic number; consider replacing it with a named constant [cppcoreguidelines-avoid-magic-numbers,readability-magic-numbers]

Trilinos/packages/nox/test/tpetra/LOCA_TestProblems/Basis.cpp

Lines 73 to 78 in f44de1c

	phi[1]=(1.0+eta)/2.0;
	dphide[0]=-0.5;
	dphide[1]=0.5;
	// Caculate basis function and derivative at GP.
	dx=0.5*(x[1]-x[0]);

!Line: 73 - warning: 2.0 is a magic number; consider replacing it with a named constant [cppcoreguidelines-avoid-magic-numbers,readability-magic-numbers]

Trilinos/packages/nox/test/tpetra/LOCA_TestProblems/Basis.cpp

Lines 74 to 79 in f44de1c

	dphide[0]=-0.5;
	dphide[1]=0.5;
	// Caculate basis function and derivative at GP.
	dx=0.5*(x[1]-x[0]);
	xx=0.0;

!Line: 74 - warning: 0.5 is a magic number; consider replacing it with a named constant [cppcoreguidelines-avoid-magic-numbers,readability-magic-numbers]

Trilinos/packages/nox/test/tpetra/LOCA_TestProblems/Basis.cpp

Lines 75 to 80 in f44de1c

	dphide[1]=0.5;
	// Caculate basis function and derivative at GP.
	dx=0.5*(x[1]-x[0]);
	xx=0.0;
	uu=0.0;

!Line: 75 - warning: 0.5 is a magic number; consider replacing it with a named constant [cppcoreguidelines-avoid-magic-numbers,readability-magic-numbers]

Trilinos/packages/nox/test/tpetra/LOCA_TestProblems/Basis.cpp

Lines 78 to 83 in f44de1c

	dx=0.5*(x[1]-x[0]);
	xx=0.0;
	uu=0.0;
	duu=0.0;
	for (int i=0; i < N; i++) {
	xx += x[i] * phi[i];

!Line: 78 - warning: 0.5 is a magic number; consider replacing it with a named constant [cppcoreguidelines-avoid-magic-numbers,readability-magic-numbers]

Trilinos/packages/nox/test/tpetra/LOCA_TestProblems/Basis.cpp

Lines 82 to 87 in f44de1c

	for (int i=0; i < N; i++) {
	xx += x[i] * phi[i];
	uu += u[i] * phi[i];
	duu += u[i] * dphide[i];
	}

!Line: 82 - warning: kernel performance could be improved by unrolling this loop with a '#pragma unroll' directive [altera-unroll-loops]

Trilinos/packages/nox/test/tpetra/LOCA_TestProblems/Basis.cpp

Lines 88 to 89 in f44de1c

	return;
	}

!Line: 88 - warning: redundant return statement at the end of a function with a void return type [readability-redundant-control-flow]

Trilinos/packages/nox/test/tpetra/LOCA_UnitTests/NGA_DevTests.cpp

Lines 18 to 23 in f44de1c

	Teuchos::GlobalMPISession mpiSession(&argc, &argv);
	auto comm = Tpetra::getDefaultComm();
	const int myRank = comm->getRank();
	// test Pitchfork_FiniteElementProblem (inheriting FiniteElementProblem)
	int numGlobalElements = 1000;

!Line: 18 - warning: variable 'mpiSession' of type 'Teuchos::GlobalMPISession' can be declared 'const' [misc-const-correctness]

Trilinos/packages/nox/test/tpetra/LOCA_UnitTests/NGA_DevTests.cpp

Lines 18 to 23 in f44de1c

	Teuchos::GlobalMPISession mpiSession(&argc, &argv);
	auto comm = Tpetra::getDefaultComm();
	const int myRank = comm->getRank();
	// test Pitchfork_FiniteElementProblem (inheriting FiniteElementProblem)
	int numGlobalElements = 1000;

!Line: 18 - warning: calling a function that uses a default argument is disallowed [fuchsia-default-arguments-calls]

Trilinos/packages/nox/test/tpetra/LOCA_UnitTests/NGA_DevTests.cpp

Lines 23 to 28 in f44de1c

	int numGlobalElements = 1000;
	auto feProblem = Pitchfork_FiniteElementProblem<ST>(numGlobalElements, comm);
	if (myRank == 0) {
	std::cout << "End Result: TEST PASSED" << std::endl;
	}

!Line: 23 - warning: variable 'numGlobalElements' of type 'int' can be declared 'const' [misc-const-correctness]

Trilinos/packages/nox/test/tpetra/LOCA_UnitTests/NGA_DevTests.cpp

Lines 23 to 28 in f44de1c

	int numGlobalElements = 1000;
	auto feProblem = Pitchfork_FiniteElementProblem<ST>(numGlobalElements, comm);
	if (myRank == 0) {
	std::cout << "End Result: TEST PASSED" << std::endl;
	}

!Line: 23 - warning: 1000 is a magic number; consider replacing it with a named constant [cppcoreguidelines-avoid-magic-numbers,readability-magic-numbers]