Skip to content
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

NOX: Adding pre/post line search user operations for LineSearchBased … #2377

Merged
merged 1 commit into from
Mar 14, 2018
Merged

NOX: Adding pre/post line search user operations for LineSearchBased … #2377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions packages/nox/src/NOX_Abstract_PrePostOperator.H
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,12 @@ public:
//! User defined method that will be executed at the end of a call to NOX::Solver::Generic::solve().
virtual void runPostSolve(const NOX::Solver::Generic& solver);

//! User defined method that will be executed before a call to NOX::LineSearch::Generic::compute(). Only to be used in NOX::Solver::LineSearchBased!
virtual void runPreLineSearch(const NOX::Solver::Generic& solver);

//! User defined method that will be executed after a call to NOX::LineSearch::Generic::compute(). Only to be used in NOX::Solver::LineSearchBased!
virtual void runPostLineSearch(const NOX::Solver::Generic& solver);

}; // class PrePostOperator
} // namespace Abstract
} // namespace NOX
Expand All @@ -151,4 +157,14 @@ runPostSolve(const NOX::Solver::Generic& /*solver*/) {
return;
}

inline void NOX::Abstract::PrePostOperator::
runPreLineSearch(const NOX::Solver::Generic& /*solver*/) {
return;
}

inline void NOX::Abstract::PrePostOperator::
runPostLineSearch(const NOX::Solver::Generic& /*solver*/) {
return;
}

#endif
12 changes: 12 additions & 0 deletions packages/nox/src/NOX_PrePostOperator_Vector.C
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,18 @@ void NOX::PrePostOperatorVector::runPostSolve(const NOX::Solver::Generic& solver
(*i)->runPostSolve(solver);
}

void NOX::PrePostOperatorVector::runPreLineSearch(const NOX::Solver::Generic& solver)
{
for (it i=ppop_vec_.begin(); i != ppop_vec_.end(); ++i)
(*i)->runPreLineSearch(solver);
}

void NOX::PrePostOperatorVector::runPostLineSearch(const NOX::Solver::Generic& solver)
{
for (it i=ppop_vec_.begin(); i != ppop_vec_.end(); ++i)
(*i)->runPostLineSearch(solver);
}

void NOX::PrePostOperatorVector::pushBack(const Teuchos::RCP<NOX::Abstract::PrePostOperator>& ppop)
{
ppop_vec_.push_back(ppop);
Expand Down
4 changes: 4 additions & 0 deletions packages/nox/src/NOX_PrePostOperator_Vector.H
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,10 @@ public:

void runPostSolve(const NOX::Solver::Generic& solver);

void runPreLineSearch(const NOX::Solver::Generic& solver);

void runPostLineSearch(const NOX::Solver::Generic& solver);

//! Add PrePostOperator to end of vector.
void pushBack(const Teuchos::RCP<NOX::Abstract::PrePostOperator>& ppop);

Expand Down
2 changes: 2 additions & 0 deletions packages/nox/src/NOX_Solver_LineSearchBased.C
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,9 @@ NOX::StatusTest::StatusType NOX::Solver::LineSearchBased::step()
*oldSolnPtr = *solnPtr;

// Do line search and compute new soln.
prePostOperator.runPreLineSearch(*this);
ok = lineSearchPtr->compute(soln, stepSize, *dirPtr, *this);
prePostOperator.runPostLineSearch(*this);
if (!ok)
{
if (stepSize == 0.0)
Expand Down
20 changes: 20 additions & 0 deletions packages/nox/src/NOX_Solver_PrePostOperator.H
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,12 @@ public:
//! User defined method that will be executed at the end of a call to NOX::Solver::Generic::solve().
virtual void runPostSolve(const NOX::Solver::Generic& solver);

//! User defined method that will be executed before a call to NOX::LineSearch::Generic::compute(). Only to be used in NOX::Solver::LineSearchBased!
virtual void runPreLineSearch(const NOX::Solver::Generic& solver);

//! User defined method that will be executed after a call to NOX::LineSearch::Generic::compute(). Only to be used in NOX::Solver::LineSearchBased!
virtual void runPostLineSearch(const NOX::Solver::Generic& solver);

protected:

//! Flag that determines if a pre/post operator has been supplied by user.
Expand Down Expand Up @@ -166,4 +172,18 @@ runPostSolve(const NOX::Solver::Generic& solver)
prePostOperatorPtr->runPostSolve(solver);
}

inline void NOX::Solver::PrePostOperator::
runPreLineSearch(const NOX::Solver::Generic& solver)
{
if (havePrePostOperator)
prePostOperatorPtr->runPreLineSearch(solver);
}

inline void NOX::Solver::PrePostOperator::
runPostLineSearch(const NOX::Solver::Generic& solver)
{
if (havePrePostOperator)
prePostOperatorPtr->runPostLineSearch(solver);
}

#endif
37 changes: 36 additions & 1 deletion packages/nox/test/basic/NOX_PrePostOperatorVector.C
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,18 @@ namespace NOX_UNIT_TEST {
int post_it_count_;
int pre_solve_count_;
int post_solve_count_;
int pre_linesearch_count_;
int post_linesearch_count_;

public:

MockPPOp() :
pre_it_count_(0),
post_it_count_(0),
pre_solve_count_(0),
post_solve_count_(0)
post_solve_count_(0),
pre_linesearch_count_(0),
post_linesearch_count_(0)
{}

void runPreIterate(const NOX::Solver::Generic& solver)
Expand All @@ -83,6 +87,12 @@ namespace NOX_UNIT_TEST {
void runPostSolve(const NOX::Solver::Generic& solver)
{post_solve_count_ += 1;}

void runPreLineSearch(const NOX::Solver::Generic& solver)
{pre_linesearch_count_ += 1;}

void runPostLineSearch(const NOX::Solver::Generic& solver)
{post_linesearch_count_ += 1;}

int preIterateCount() const
{return pre_it_count_;}

Expand All @@ -95,6 +105,12 @@ namespace NOX_UNIT_TEST {
int postSolveCount() const
{return post_solve_count_;}

int preLineSearchCount() const
{return pre_linesearch_count_;}

int postLineSearchCount() const
{return post_linesearch_count_;}

};

class MockSolver : public NOX::Solver::Generic {
Expand Down Expand Up @@ -170,20 +186,39 @@ namespace NOX_UNIT_TEST {
ppop_vec.runPostSolve(solver);
ppop_vec.runPostSolve(solver);

ppop_vec.runPreLineSearch(solver);
ppop_vec.runPreLineSearch(solver);
ppop_vec.runPreLineSearch(solver);
ppop_vec.runPreLineSearch(solver);
ppop_vec.runPreLineSearch(solver);

ppop_vec.runPostLineSearch(solver);
ppop_vec.runPostLineSearch(solver);
ppop_vec.runPostLineSearch(solver);
ppop_vec.runPostLineSearch(solver);
ppop_vec.runPostLineSearch(solver);
ppop_vec.runPostLineSearch(solver);

TEST_EQUALITY(mock_ppop_1->preIterateCount(), 1);
TEST_EQUALITY(mock_ppop_1->postIterateCount(), 2);
TEST_EQUALITY(mock_ppop_1->preSolveCount(), 3);
TEST_EQUALITY(mock_ppop_1->postSolveCount(), 4);
TEST_EQUALITY(mock_ppop_1->preLineSearchCount(), 5);
TEST_EQUALITY(mock_ppop_1->postLineSearchCount(), 6);

TEST_EQUALITY(mock_ppop_2->preIterateCount(), 1);
TEST_EQUALITY(mock_ppop_2->postIterateCount(), 2);
TEST_EQUALITY(mock_ppop_2->preSolveCount(), 3);
TEST_EQUALITY(mock_ppop_2->postSolveCount(), 4);
TEST_EQUALITY(mock_ppop_2->preLineSearchCount(), 5);
TEST_EQUALITY(mock_ppop_2->postLineSearchCount(), 6);

TEST_EQUALITY(mock_ppop_3->preIterateCount(), 0);
TEST_EQUALITY(mock_ppop_3->postIterateCount(), 0);
TEST_EQUALITY(mock_ppop_3->preSolveCount(), 0);
TEST_EQUALITY(mock_ppop_3->postSolveCount(), 0);
TEST_EQUALITY(mock_ppop_3->preLineSearchCount(), 0);
TEST_EQUALITY(mock_ppop_3->postLineSearchCount(), 0);

}

Expand Down
4 changes: 4 additions & 0 deletions packages/nox/test/epetra/1Dfem/1Dfem.C
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,10 @@ int main(int argc, char *argv[])
status = 4;
if (ppo2.getNumRunPostSolve() != 1)
status = 4;
if (ppo2.getNumRunPreLineSearch() != 10)
status = 4;
if (ppo2.getNumRunPostLineSearch() != 10)
status = 4;
}

success = status==0;
Expand Down
16 changes: 16 additions & 0 deletions packages/nox/test/epetra/1Dfem/1DfemPrePostOperator.C
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,19 @@ runPostSolve(const NOX::Solver::Generic& solver)
utils.out(NOX::Utils::Details)
<< "1Dfem's runPostSolve() routine called!" << std::endl;
}

void UserPrePostOperator::
runPreLineSearch(const NOX::Solver::Generic& solver)
{
++numRunPreLineSearch;
utils.out(NOX::Utils::Details)
<< "1Dfem's runPreLineSearch() routine called!" << std::endl;
}

void UserPrePostOperator::
runPostLineSearch(const NOX::Solver::Generic& solver)
{
++numRunPostLineSearch;
utils.out(NOX::Utils::Details)
<< "1Dfem's runPostLineSearch() routine called!" << std::endl;
}
10 changes: 10 additions & 0 deletions packages/nox/test/epetra/1Dfem/1DfemPrePostOperator.H
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,10 @@ public:

void runPostSolve(const NOX::Solver::Generic& solver);

void runPreLineSearch(const NOX::Solver::Generic& solver);

void runPostLineSearch(const NOX::Solver::Generic& solver);

int getNumRunPreIterate() const { return numRunPreIterate; };

int getNumRunPostIterate() const { return numRunPostIterate; };
Expand All @@ -81,6 +85,10 @@ public:

int getNumRunPostSolve() const { return numRunPostSolve; };

int getNumRunPreLineSearch() const { return numRunPreLineSearch; };

int getNumRunPostLineSearch() const { return numRunPostLineSearch; };

protected:

NOX::Utils utils;
Expand All @@ -89,6 +97,8 @@ protected:
int numRunPostIterate;
int numRunPreSolve;
int numRunPostSolve;
int numRunPreLineSearch;
int numRunPostLineSearch;

};
#endif