GRINS::SolverContext Class Reference

Simple class to hold objects passed to Solver::solve. More...

#include <solver_context.h>

Collaboration diagram for GRINS::SolverContext:

Public Member Functions
	SolverContext ()
	~SolverContext ()

Public Attributes
GRINS::MultiphysicsSystem *	system
SharedPtr< libMesh::EquationSystems >	equation_system
SharedPtr< GRINS::Visualization >	vis
unsigned int	timesteps_per_vis
unsigned int	timesteps_per_perflog
bool	output_vis
bool	output_adjoint
bool	output_residual
bool	output_residual_sensitivities
bool	output_solution_sensitivities
bool	print_perflog
bool	print_scalars
bool	do_adjoint_solve
SharedPtr< QoIOutput >	qoi_output
SharedPtr< PostProcessedQuantities< libMesh::Real > >	postprocessing
SharedPtr< libMesh::ErrorEstimator >	error_estimator
bool	have_restart

Detailed Description

Simple class to hold objects passed to Solver::solve.

Allows some flexibility for adding objects needed to pass to the Solver::solve method so that the solver can still be agnostic to creation etc. of those objects, but can operate on them.

Definition at line 51 of file solver_context.h.

Constructor & Destructor Documentation

GRINS::SolverContext::SolverContext

(

)

Definition at line 34 of file solver_context.C.

    : system(NULL),
      equation_system( SharedPtr<libMesh::EquationSystems>() ),
      vis( SharedPtr<GRINS::Visualization>() ),
      timesteps_per_vis( 1 ),
      timesteps_per_perflog( 1 ),
      output_vis( false ),
      output_adjoint(false),
      output_residual( false ),
      output_residual_sensitivities( false ),
      output_solution_sensitivities( false ),
      print_perflog( false ),
      print_scalars( false ),
      do_adjoint_solve(false),
      postprocessing( SharedPtr<PostProcessedQuantities<libMesh::Real> >() ),
      have_restart(false)
  {}

GRINS::SolverContext::~SolverContext ( )

inline

Definition at line 56 of file solver_context.h.

{};

Member Data Documentation

bool GRINS::SolverContext::do_adjoint_solve

Definition at line 70 of file solver_context.h.

Referenced by GRINS::MeshAdaptiveSolverBase::check_for_convergence(), GRINS::Simulation::run(), GRINS::SteadySolver::solve(), and GRINS::SteadyMeshAdaptiveSolver::solve().

SharedPtr<libMesh::EquationSystems> GRINS::SolverContext::equation_system

Definition at line 59 of file solver_context.h.

Referenced by GRINS::MeshAdaptiveSolverBase::estimate_error_for_amr(), GRINS::SteadySolver::forward_qoi_parameter_sensitivity(), GRINS::SteadyMeshAdaptiveSolver::forward_qoi_parameter_sensitivity(), GRINS::MeshAdaptiveSolverBase::perform_amr(), GRINS::Simulation::run(), GRINS::SteadySolver::solve(), GRINS::UnsteadySolver::solve(), GRINS::UnsteadyMeshAdaptiveSolver::solve(), and GRINS::SteadyMeshAdaptiveSolver::solve().

SharedPtr<libMesh::ErrorEstimator> GRINS::SolverContext::error_estimator

Definition at line 76 of file solver_context.h.

Referenced by GRINS::SteadyMeshAdaptiveSolver::check_qoi_error_option_consistency(), GRINS::MeshAdaptiveSolverBase::estimate_error_for_amr(), GRINS::Simulation::run(), and GRINS::SteadyMeshAdaptiveSolver::solve().

bool GRINS::SolverContext::have_restart

Definition at line 78 of file solver_context.h.

Referenced by GRINS::UnsteadySolver::init_second_order_in_time_solvers(), and GRINS::Simulation::run().

bool GRINS::SolverContext::output_adjoint

Definition at line 64 of file solver_context.h.

Referenced by GRINS::Simulation::run(), GRINS::SteadySolver::solve(), and GRINS::SteadyMeshAdaptiveSolver::solve().

bool GRINS::SolverContext::output_residual

Definition at line 65 of file solver_context.h.

Referenced by GRINS::Simulation::run(), GRINS::SteadySolver::solve(), GRINS::UnsteadySolver::solve(), GRINS::SteadyMeshAdaptiveSolver::solve(), and GRINS::UnsteadyMeshAdaptiveSolver::solve().

bool GRINS::SolverContext::output_residual_sensitivities

Definition at line 66 of file solver_context.h.

Referenced by GRINS::SteadySolver::forward_qoi_parameter_sensitivity(), GRINS::SteadyMeshAdaptiveSolver::forward_qoi_parameter_sensitivity(), and GRINS::Simulation::run().

bool GRINS::SolverContext::output_solution_sensitivities

Definition at line 67 of file solver_context.h.

Referenced by GRINS::SteadySolver::forward_qoi_parameter_sensitivity(), GRINS::SteadyMeshAdaptiveSolver::forward_qoi_parameter_sensitivity(), and GRINS::Simulation::run().

bool GRINS::SolverContext::output_vis

Definition at line 63 of file solver_context.h.

Referenced by GRINS::Simulation::run(), GRINS::SteadySolver::solve(), GRINS::UnsteadySolver::solve(), GRINS::SteadyMeshAdaptiveSolver::solve(), and GRINS::UnsteadyMeshAdaptiveSolver::solve().

SharedPtr<PostProcessedQuantities<libMesh::Real> > GRINS::SolverContext::postprocessing

Definition at line 74 of file solver_context.h.

Referenced by GRINS::Simulation::run(), GRINS::SteadySolver::solve(), GRINS::UnsteadySolver::solve(), GRINS::SteadyMeshAdaptiveSolver::solve(), and GRINS::UnsteadyMeshAdaptiveSolver::solve().

bool GRINS::SolverContext::print_perflog

Definition at line 68 of file solver_context.h.

Referenced by GRINS::Simulation::run(), GRINS::UnsteadySolver::solve(), and GRINS::UnsteadyMeshAdaptiveSolver::solve().

bool GRINS::SolverContext::print_scalars

Definition at line 69 of file solver_context.h.

Referenced by GRINS::Simulation::run(), GRINS::SteadySolver::solve(), GRINS::UnsteadySolver::solve(), and GRINS::UnsteadyMeshAdaptiveSolver::solve().

SharedPtr<QoIOutput> GRINS::SolverContext::qoi_output

Definition at line 72 of file solver_context.h.

Referenced by GRINS::Solver::print_qoi(), GRINS::Simulation::run(), GRINS::SteadyMeshAdaptiveSolver::solve(), and GRINS::UnsteadyMeshAdaptiveSolver::solve().

GRINS::MultiphysicsSystem* GRINS::SolverContext::system

Definition at line 56 of file solver_context.h.

Referenced by GRINS::SteadySolver::adjoint_qoi_parameter_sensitivity(), GRINS::SteadyMeshAdaptiveSolver::adjoint_qoi_parameter_sensitivity(), GRINS::MeshAdaptiveSolverBase::estimate_error_for_amr(), GRINS::SteadySolver::forward_qoi_parameter_sensitivity(), GRINS::SteadyMeshAdaptiveSolver::forward_qoi_parameter_sensitivity(), GRINS::UnsteadySolver::init_second_order_in_time_solvers(), GRINS::MeshAdaptiveSolverBase::perform_amr(), GRINS::Solver::print_qoi(), GRINS::Solver::print_scalar_vars(), GRINS::Simulation::run(), GRINS::SteadySolver::solve(), GRINS::UnsteadySolver::solve(), GRINS::UnsteadyMeshAdaptiveSolver::solve(), GRINS::SteadyMeshAdaptiveSolver::solve(), GRINS::Solver::steady_adjoint_solve(), and GRINS::UnsteadySolver::update_dirichlet_bcs().

unsigned int GRINS::SolverContext::timesteps_per_perflog

Definition at line 62 of file solver_context.h.

Referenced by GRINS::Simulation::run(), GRINS::UnsteadySolver::solve(), and GRINS::UnsteadyMeshAdaptiveSolver::solve().

unsigned int GRINS::SolverContext::timesteps_per_vis

Definition at line 61 of file solver_context.h.

Referenced by GRINS::Simulation::run(), GRINS::UnsteadySolver::solve(), and GRINS::UnsteadyMeshAdaptiveSolver::solve().

SharedPtr<GRINS::Visualization> GRINS::SolverContext::vis

Definition at line 60 of file solver_context.h.

Referenced by GRINS::SteadySolver::forward_qoi_parameter_sensitivity(), GRINS::SteadyMeshAdaptiveSolver::forward_qoi_parameter_sensitivity(), GRINS::Simulation::run(), GRINS::SteadySolver::solve(), GRINS::UnsteadySolver::solve(), GRINS::UnsteadyMeshAdaptiveSolver::solve(), and GRINS::SteadyMeshAdaptiveSolver::solve().

---

The documentation for this class was generated from the following files:

• src/solver/include/grins/solver_context.h
• src/solver/src/solver_context.C