Chi-Tech
Public Member Functions | Static Public Member Functions | Protected Attributes | Static Private Member Functions | Private Attributes
chi_physics::Solver Class Reference

#include <chi_solver.h>

Inheritance diagram for chi_physics::Solver:
ChiObject cfem_diffusion::Solver chi_diffusion::Solver dfem_diffusion::Solver fv_diffusion::Solver lbs::LBSSolver lbs::SteadyStateSolver lbs::TransientSolver lbs::XXNonLinearKEigen lbs::XXPowerIterationKEigen mg_diffusion::Solver prk::TransientSolver

Public Member Functions

 Solver (std::string in_text_name)
 
 Solver (std::string in_text_name, std::initializer_list< BasicOption > in_options)
 
 Solver (const chi::InputParameters &params)
 
virtual ~Solver ()=default
 
std::string TextName () const
 
BasicOptions & GetBasicOptions ()
 
const BasicOptions & GetBasicOptions () const
 
std::vector< std::shared_ptr< FieldFunctionGridBased > > & GetFieldFunctions ()
 
const std::vector< std::shared_ptr< FieldFunctionGridBased > > & GetFieldFunctions () const
 
TimeStepper & GetTimeStepper ()
 
const TimeStepper & GetTimeStepper () const
 
virtual void Initialize ()
 
virtual void Execute ()
 
virtual void Step ()
 
virtual void Advance ()
 
virtual chi::ParameterBlock GetInfo (const chi::ParameterBlock &params) const
 
virtual void SetProperties (const chi::ParameterBlock &params)
 
chi::ParameterBlock GetInfoWithPreCheck (const chi::ParameterBlock &params) const
 
- Public Member Functions inherited from ChiObject
 ChiObject ()
 
 ChiObject (const chi::InputParameters &params)
 
void SetStackID (size_t stack_id)
 
size_t StackID () const
 
virtual void PushOntoStack (std::shared_ptr< ChiObject > &new_object)
 
virtual ~ChiObject ()=default
 

Static Public Member Functions

static chi::InputParameters GetInputParameters ()
 
- Static Public Member Functions inherited from ChiObject
static chi::InputParameters GetInputParameters ()
 

Protected Attributes

BasicOptions basic_options_
 
std::vector< std::shared_ptr< FieldFunctionGridBased > > field_functions_
 
std::shared_ptr< TimeStepper > timestepper_ = nullptr
 

Static Private Member Functions

static std::shared_ptr< TimeStepper > InitTimeStepper (const chi::InputParameters &params)
 

Private Attributes

const std::string text_name_
 

Detailed Description

Definition at line 21 of file chi_solver.h.

Constructor & Destructor Documentation

◆ Solver() [1/3]

chi_physics::Solver::Solver ( std::string  in_text_name)
explicit

Definition at line 48 of file chi_solver.cc.

◆ Solver() [2/3]

chi_physics::Solver::Solver ( std::string  in_text_name,
std::initializer_list< BasicOption >  in_options 
)

Definition at line 54 of file chi_solver.cc.

◆ Solver() [3/3]

chi_physics::Solver::Solver ( const chi::InputParameters &  params)
explicit

Definition at line 62 of file chi_solver.cc.

◆ ~Solver()

virtual chi_physics::Solver::~Solver ( )
virtualdefault

Reimplemented in chi_diffusion::Solver, cfem_diffusion::Solver, dfem_diffusion::Solver, fv_diffusion::Solver, and mg_diffusion::Solver.

Member Function Documentation

◆ Advance()

void chi_physics::Solver::Advance ( )
virtual

Reimplemented in lbs::TransientSolver, and prk::TransientSolver.

Definition at line 161 of file chi_solver.cc.

◆ Execute()

void chi_physics::Solver::Execute ( )
virtual

Reimplemented in cfem_diffusion::Solver, dfem_diffusion::Solver, chi_diffusion::Solver, fv_diffusion::Solver, lbs::DiscreteOrdinatesAdjointSolver, lbs::SteadyStateSolver, lbs::TransientSolver, lbs::XXNonLinearKEigen, lbs::XXPowerIterationKEigen, lbs::XXPowerIterationKEigenSCDSA, mg_diffusion::Solver, and prk::TransientSolver.

Definition at line 151 of file chi_solver.cc.

◆ GetBasicOptions() [1/2]

BasicOptions & chi_physics::Solver::GetBasicOptions ( )

Definition at line 118 of file chi_solver.cc.

◆ GetBasicOptions() [2/2]

const BasicOptions & chi_physics::Solver::GetBasicOptions ( ) const

Definition at line 120 of file chi_solver.cc.

◆ GetFieldFunctions() [1/2]

std::vector< std::shared_ptr< FieldFunctionGridBased > > & chi_physics::Solver::GetFieldFunctions ( )

Definition at line 123 of file chi_solver.cc.

◆ GetFieldFunctions() [2/2]

const std::vector< std::shared_ptr< FieldFunctionGridBased > > & chi_physics::Solver::GetFieldFunctions ( ) const

Definition at line 141 of file chi_solver.cc.

◆ GetInfo()

chi::ParameterBlock chi_physics::Solver::GetInfo ( const chi::ParameterBlock &  params) const
virtual

Generalized query for information supporting varying returns.

Reimplemented in prk::TransientSolver.

Definition at line 166 of file chi_solver.cc.

◆ GetInfoWithPreCheck()

chi::ParameterBlock chi_physics::Solver::GetInfoWithPreCheck ( const chi::ParameterBlock &  params) const

PreCheck call to GetInfo.

Definition at line 172 of file chi_solver.cc.

◆ GetInputParameters()

chi::InputParameters chi_physics::Solver::GetInputParameters ( )
static

Returns the input parameters.

Definition at line 16 of file chi_solver.cc.

◆ GetTimeStepper() [1/2]

TimeStepper & chi_physics::Solver::GetTimeStepper ( )

Definition at line 128 of file chi_solver.cc.

◆ GetTimeStepper() [2/2]

const TimeStepper & chi_physics::Solver::GetTimeStepper ( ) const

Definition at line 134 of file chi_solver.cc.

◆ Initialize()

void chi_physics::Solver::Initialize ( )
virtual

Reimplemented in cfem_diffusion::Solver, dfem_diffusion::Solver, chi_diffusion::Solver, fv_diffusion::Solver, lbs::LBSSolver, lbs::DiffusionDFEMSolver, lbs::DiscreteOrdinatesSolver, lbs::DiscreteOrdinatesAdjointSolver, lbs::SteadyStateSolver, lbs::TransientSolver, lbs::XXNonLinearKEigen, lbs::XXPowerIterationKEigen, lbs::XXPowerIterationKEigenSCDSA, mg_diffusion::Solver, and prk::TransientSolver.

Definition at line 146 of file chi_solver.cc.

◆ InitTimeStepper()

std::shared_ptr< TimeStepper > chi_physics::Solver::InitTimeStepper ( const chi::InputParameters &  params)
staticprivate

Definition at line 70 of file chi_solver.cc.

◆ SetProperties()

void chi_physics::Solver::SetProperties ( const chi::ParameterBlock &  params)
virtual

Base solver settable properties:

  • dt, Timestep size
  • time, Current time

Reimplemented in prk::TransientSolver.

Definition at line 195 of file chi_solver.cc.

◆ Step()

void chi_physics::Solver::Step ( )
virtual

Reimplemented in lbs::TransientSolver, and prk::TransientSolver.

Definition at line 156 of file chi_solver.cc.

◆ TextName()

std::string chi_physics::Solver::TextName ( ) const

Definition at line 116 of file chi_solver.cc.

Field Documentation

◆ basic_options_

BasicOptions chi_physics::Solver::basic_options_
protected

Definition at line 57 of file chi_solver.h.

◆ field_functions_

std::vector<std::shared_ptr<FieldFunctionGridBased> > chi_physics::Solver::field_functions_
protected

Definition at line 58 of file chi_solver.h.

◆ text_name_

const std::string chi_physics::Solver::text_name_
private

Definition at line 64 of file chi_solver.h.

◆ timestepper_

std::shared_ptr<TimeStepper> chi_physics::Solver::timestepper_ = nullptr
protected

Definition at line 59 of file chi_solver.h.

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