#include <Flow1DSolver.h>
Definition at line 12 of file Flow1DSolver.h.
◆ shared_ptr
◆ SolverStatus
| Enumerator |
|---|
| ConvergedOnAbsTol | |
| ConvergedOnRelTol | |
| ConvergedUserCondition | |
| MaxIterations | |
| DivergedLineSearch | |
| DivergedStepSize | |
| DivergedFunctionCount | |
| DivergedOnNan | |
| DivergedNestedSolver | |
| DivergedOther | |
Definition at line 62 of file SolverStrategy.h.
◆ Flow1DSolver()
◆ ~Flow1DSolver()
| virtual AMP::Solver::Flow1DSolver::~Flow1DSolver |
( |
| ) |
|
|
virtual |
◆ apply()
Solve the system \(A(u) = f\). This is a pure virtual function that the derived classes need to provide an implementation of.
- Parameters
-
| [in] | f | shared pointer to right hand side vector |
| [out] | u | shared pointer to approximate computed solution |
Implements AMP::Solver::SolverStrategy.
◆ checkStoppingCriteria()
|
|
protectedvirtualinherited |
◆ getAbsoluteTolerance()
| AMP::Scalar AMP::Solver::SolverStrategy::getAbsoluteTolerance |
( |
| ) |
const |
|
inlineinherited |
◆ getBaseFromInput()
| void AMP::Solver::SolverStrategy::getBaseFromInput |
( |
std::shared_ptr< AMP::Database > |
db | ) |
|
|
protectedinherited |
◆ getConverged()
| bool AMP::Solver::SolverStrategy::getConverged |
( |
void |
| ) |
const |
|
inlineinherited |
◆ getConvergenceStatus()
◆ getConvergenceStatusString()
| std::string AMP::Solver::SolverStrategy::getConvergenceStatusString |
( |
void |
| ) |
const |
|
inlineinherited |
◆ getDebugPrintInfoLevel()
| int AMP::Solver::SolverStrategy::getDebugPrintInfoLevel |
( |
void |
| ) |
|
|
inlineinherited |
◆ getExecutionSpace()
◆ getFunctionScaling()
◆ getInitialResidual()
◆ getInputVariable()
◆ getIterationHistory()
◆ getIterations()
◆ getMaxIterations()
| int AMP::Solver::SolverStrategy::getMaxIterations |
( |
void |
| ) |
const |
|
inlineinherited |
◆ getNestedSolver()
◆ getOperator()
Return a shared pointer to the operator registered with the solver.
◆ getRelativeTolerance()
| AMP::Scalar AMP::Solver::SolverStrategy::getRelativeTolerance |
( |
| ) |
const |
|
inlineinherited |
◆ getResidualNorm()
◆ getSolutionScaling()
◆ getTotalNumberOfIterations()
| int AMP::Solver::SolverStrategy::getTotalNumberOfIterations |
( |
void |
| ) |
|
|
inherited |
◆ initialize()
Initialize the solution vector and potentially create internal vectors needed for solution
- Parameters
-
| [in] | parameters | The parameters object contains a database object. Currently there are no required fields for the database object. |
Reimplemented from AMP::Solver::SolverStrategy.
◆ print()
| virtual void AMP::Solver::SolverStrategy::print |
( |
std::ostream & |
| ) |
|
|
inlinevirtualinherited |
◆ printConvergenceStatus()
◆ printStatistics()
◆ registerOperator()
Register the operator that the solver will use during solves
- Parameters
-
| [in] | op | shared pointer to operator \(A()\) for equation \(A(u) = f\) |
Reimplemented in AMP::Solver::BiCGSTABSolver< T >, AMP::Solver::CGSolver< T >, AMP::Solver::DiagonalSolver< T >, AMP::Solver::GMRESSolver< T >, AMP::Solver::HypreSolver, AMP::Solver::PetscKrylovSolver, AMP::Solver::TFQMRSolver< T >, AMP::Solver::TrilinosMLSolver, AMP::Solver::TrilinosMueLuSolver, AMP::Solver::NonlinearKrylovAccelerator< T >, AMP::Solver::AMG::HybridGS, AMP::Solver::AMG::JacobiL1, and AMP::Solver::AMG::UASolver.
◆ registerWriter()
Registers a writer with the solver.
This function will register a writer with the solver. The solver may then register any vector components it "owns" with the writer.
- Parameters
-
| writer | The writer to register |
Definition at line 186 of file SolverStrategy.h.
References AMP::Solver::SolverStrategy::d_writer.
◆ reset()
◆ resetOperator()
Resets the operator registered with the solver with new parameters if necessary
- Parameters
-
| parameters | OperatorParameters object that is NULL by default |
Reimplemented from AMP::Solver::SolverStrategy.
◆ residual()
◆ setAbsoluteTolerance()
◆ setComponentScalings()
◆ setDebugPrintInfoLevel()
| virtual void AMP::Solver::SolverStrategy::setDebugPrintInfoLevel |
( |
int |
print_level | ) |
|
|
inlinevirtualinherited |
Specify level of diagnostic information printed during iterations.
- Parameters
-
| [in] | print_level | integer level value with permissible values 0 and higher. Setting to zero should provide minimial debugging information with higher values resulting in increasingly verbose information being printed out. |
Definition at line 132 of file SolverStrategy.h.
References AMP::Solver::SolverStrategy::d_iDebugPrintInfoLevel.
◆ setExecutionSpace()
◆ setInitialGuess()
Provide the initial guess for the solver. This is a pure virtual function that the derived classes need to provide an implementation of.
- Parameters
-
| [in] | initialGuess | shared pointer to the initial guess vector. |
Reimplemented from AMP::Solver::SolverStrategy.
◆ setIsNestedSolver()
| void AMP::Solver::SolverStrategy::setIsNestedSolver |
( |
bool |
is_nested | ) |
|
|
inlineinherited |
◆ setMaxIterations()
◆ setNestedSolver()
◆ setRelativeTolerance()
◆ setZeroInitialGuess()
| virtual void AMP::Solver::SolverStrategy::setZeroInitialGuess |
( |
bool |
use_zero_guess | ) |
|
|
inlinevirtualinherited |
◆ statusToString()
◆ type()
| std::string AMP::Solver::Flow1DSolver::type |
( |
| ) |
const |
|
inlineoverridevirtual |
◆ d_bComputeResidual
| bool AMP::Solver::SolverStrategy::d_bComputeResidual = false |
|
protectedinherited |
◆ d_bIsNestedSolver
| bool AMP::Solver::SolverStrategy::d_bIsNestedSolver = false |
|
protectedinherited |
◆ d_bUseZeroInitialGuess
| bool AMP::Solver::SolverStrategy::d_bUseZeroInitialGuess = true |
|
protectedinherited |
◆ d_cladVec
◆ d_ConvergenceStatus
◆ d_Cp
| double AMP::Solver::Flow1DSolver::d_Cp |
|
protected |
◆ d_dAbsoluteTolerance
| AMP::Scalar AMP::Solver::SolverStrategy::d_dAbsoluteTolerance = 1.0e-14 |
|
protectedinherited |
◆ d_db
◆ d_dCp
| double AMP::Solver::Flow1DSolver::d_dCp |
|
protected |
◆ d_De
| double AMP::Solver::Flow1DSolver::d_De |
|
protected |
◆ d_dInitialResidual
| AMP::Scalar AMP::Solver::SolverStrategy::d_dInitialResidual |
|
protectedinherited |
◆ d_dRelativeTolerance
| AMP::Scalar AMP::Solver::SolverStrategy::d_dRelativeTolerance = 1.0e-09 |
|
protectedinherited |
◆ d_dResidualNorm
| AMP::Scalar AMP::Solver::SolverStrategy::d_dResidualNorm |
|
protectedinherited |
◆ d_exec_space
◆ d_G
| double AMP::Solver::Flow1DSolver::d_G |
|
protected |
◆ d_global_db
Pointer to global database This is temporary fix and eventually either d_global_db or d_db should go away This is introduced to allow for solver factories to access databases in the global database for the construction of nested solvers
Definition at line 311 of file SolverStrategy.h.
◆ d_iDebugPrintInfoLevel
| int AMP::Solver::SolverStrategy::d_iDebugPrintInfoLevel = 0 |
|
protectedinherited |
◆ d_iInstanceId
| int AMP::Solver::SolverStrategy::d_iInstanceId |
|
staticprotectedinherited |
◆ d_iMaxIterations
| int AMP::Solver::SolverStrategy::d_iMaxIterations = 0 |
|
protectedinherited |
◆ d_inpVariable
◆ d_iNumberIterations
| int AMP::Solver::SolverStrategy::d_iNumberIterations = 0 |
|
protectedinherited |
◆ d_iObjectId
| int AMP::Solver::SolverStrategy::d_iObjectId |
|
protectedinherited |
◆ d_iterationHistory
| std::vector<int> AMP::Solver::SolverStrategy::d_iterationHistory |
|
protectedinherited |
◆ d_K
| double AMP::Solver::Flow1DSolver::d_K |
|
protected |
◆ d_memory_location
◆ d_numpoints
| int AMP::Solver::Flow1DSolver::d_numpoints |
|
protected |
◆ d_outVariable
◆ d_pFunctionScaling
◆ d_pNestedSolver
◆ d_pOperator
◆ d_Pr
| double AMP::Solver::Flow1DSolver::d_Pr |
|
protected |
◆ d_pSolutionScaling
◆ d_Re
| double AMP::Solver::Flow1DSolver::d_Re |
|
protected |
◆ d_Rhs
◆ d_sName
| std::string AMP::Solver::SolverStrategy::d_sName |
|
protectedinherited |
◆ d_Sol
◆ d_writer
◆ zPoints
| std::vector<double> AMP::Solver::Flow1DSolver::zPoints |
|
protected |
The documentation for this class was generated from the following file: