sierra::nalu::TimeIntegrator Class Reference

#include <TimeIntegrator.h>

Public Member Functions
	TimeIntegrator ()
	TimeIntegrator (Simulation *sim)
	~TimeIntegrator ()
void	load (const YAML::Node &node)
void	breadboard ()
void	initialize ()
Simulation *	root ()
Simulation *	parent ()
void	integrate_realm ()
void	provide_mean_norm ()
bool	simulation_proceeds ()
double	get_time_step (const NaluState &theState=NALU_STATE_N) const
double	get_current_time () const
double	get_gamma1 () const
double	get_gamma2 () const
double	get_gamma3 () const
int	get_time_step_count () const
double	get_time_step_from_file ()
bool	get_is_fixed_time_step ()
bool	get_is_terminate_based_on_time ()
double	get_total_sim_time ()
int	get_max_time_step_count ()
void	compute_gamma ()

Public Attributes
Simulation *	sim_ {nullptr}
double	totalSimTime_
double	currentTime_
double	timeStepFromFile_
double	timeStepN_
double	timeStepNm1_
double	gamma1_
double	gamma2_
double	gamma3_
int	timeStepCount_
int	maxTimeStepCount_
bool	secondOrderTimeAccurate_
bool	adaptiveTimeStep_
bool	terminateBasedOnTime_
int	nonlinearIterations_
std::string	name_
std::vector< std::string >	realmNamesVec_
std::vector< Realm * >	realmVec_

Constructor & Destructor Documentation

sierra::nalu::TimeIntegrator::TimeIntegrator ( )

inline

References breadboard(), initialize(), integrate_realm(), load(), parent(), provide_mean_norm(), root(), simulation_proceeds(), and ~TimeIntegrator().

sierra::nalu::TimeIntegrator::TimeIntegrator

(

Simulation *

sim

)

sierra::nalu::TimeIntegrator::~TimeIntegrator

(

)

Referenced by TimeIntegrator().

Member Function Documentation

void sierra::nalu::TimeIntegrator::breadboard

(

)

References sierra::nalu::Realms::find_realm(), realmNamesVec_, sierra::nalu::Simulation::realms_, realmVec_, sim_, and sierra::nalu::Realm::timeIntegrator_.

Referenced by sierra::nalu::Simulation::breadboard(), and TimeIntegrator().

void sierra::nalu::TimeIntegrator::compute_gamma

(

)

References gamma1_, gamma2_, gamma3_, timeStepCount_, timeStepN_, and timeStepNm1_.

Referenced by integrate_realm().

double sierra::nalu::TimeIntegrator::get_current_time

(

)

const

References currentTime_.

Referenced by sierra::nalu::Realm::get_current_time().

double sierra::nalu::TimeIntegrator::get_gamma1

(

)

const

References gamma1_.

Referenced by sierra::nalu::Realm::get_gamma1(), sierra::nalu::ContinuityAdvElemKernel< AlgTraits >::setup(), sierra::nalu::ContinuityMassElemKernel< AlgTraits >::setup(), sierra::nalu::MomentumMassElemKernel< AlgTraits >::setup(), sierra::nalu::ScalarMassElemKernel< AlgTraits >::setup(), sierra::nalu::ScalarNSOElemKernel< AlgTraits >::setup(), and sierra::nalu::MomentumNSOElemKernel< AlgTraits >::setup().

double sierra::nalu::TimeIntegrator::get_gamma2

(

)

const

References gamma2_.

Referenced by sierra::nalu::Realm::get_gamma2(), sierra::nalu::ContinuityMassElemKernel< AlgTraits >::setup(), sierra::nalu::MomentumMassElemKernel< AlgTraits >::setup(), sierra::nalu::ScalarMassElemKernel< AlgTraits >::setup(), sierra::nalu::MomentumNSOElemKernel< AlgTraits >::setup(), and sierra::nalu::ScalarNSOElemKernel< AlgTraits >::setup().

double sierra::nalu::TimeIntegrator::get_gamma3

(

)

const

References gamma3_.

Referenced by sierra::nalu::Realm::get_gamma3(), sierra::nalu::ContinuityMassElemKernel< AlgTraits >::setup(), sierra::nalu::MomentumMassElemKernel< AlgTraits >::setup(), sierra::nalu::ScalarMassElemKernel< AlgTraits >::setup(), sierra::nalu::MomentumNSOElemKernel< AlgTraits >::setup(), and sierra::nalu::ScalarNSOElemKernel< AlgTraits >::setup().

bool sierra::nalu::TimeIntegrator::get_is_fixed_time_step

(

)

References adaptiveTimeStep_.

Referenced by sierra::nalu::Realm::get_is_fixed_time_step().

bool sierra::nalu::TimeIntegrator::get_is_terminate_based_on_time

(

)

References terminateBasedOnTime_.

Referenced by sierra::nalu::Realm::get_is_terminate_based_on_time().

int sierra::nalu::TimeIntegrator::get_max_time_step_count

(

)

References maxTimeStepCount_, and terminateBasedOnTime_.

Referenced by sierra::nalu::Realm::get_max_time_step_count().

double sierra::nalu::TimeIntegrator::get_time_step

(

const NaluState &

theState = NALU_STATE_N

)

const

References sierra::nalu::NALU_STATE_N, sierra::nalu::NALU_STATE_NM1, timeStepN_, and timeStepNm1_.

Referenced by sierra::nalu::AssembleCourantReynoldsElemAlgorithm::execute(), sierra::nalu::Realm::get_time_step(), sierra::nalu::Realm::provide_restart_output(), sierra::nalu::ContinuityLowSpeedCompressibleNodeSuppAlg::setup(), sierra::nalu::HeatCondMassBackwardEulerNodeSuppAlg::setup(), sierra::nalu::MeshDisplacementMassBackwardEulerNodeSuppAlg::setup(), sierra::nalu::ContinuityMassBackwardEulerNodeSuppAlg::setup(), sierra::nalu::MomentumMassBackwardEulerNodeSuppAlg::setup(), sierra::nalu::ContinuityGclNodeSuppAlg::setup(), sierra::nalu::EnthalpyLowSpeedCompressibleNodeSuppAlg::setup(), sierra::nalu::ScalarMassBackwardEulerNodeSuppAlg::setup(), sierra::nalu::ContinuityAdvElemKernel< AlgTraits >::setup(), sierra::nalu::MomentumMassElemKernel< AlgTraits >::setup(), sierra::nalu::ContinuityMassElemKernel< AlgTraits >::setup(), sierra::nalu::ScalarMassElemKernel< AlgTraits >::setup(), sierra::nalu::ScalarNSOElemKernel< AlgTraits >::setup(), and sierra::nalu::MomentumNSOElemKernel< AlgTraits >::setup().

int sierra::nalu::TimeIntegrator::get_time_step_count

(

)

const

References timeStepCount_.

Referenced by sierra::nalu::Realm::get_time_step_count().

double sierra::nalu::TimeIntegrator::get_time_step_from_file

(

)

References timeStepFromFile_.

Referenced by sierra::nalu::Realm::get_time_step_from_file().

double sierra::nalu::TimeIntegrator::get_total_sim_time

(

)

References terminateBasedOnTime_, and totalSimTime_.

Referenced by sierra::nalu::Realm::get_total_sim_time().

void sierra::nalu::TimeIntegrator::initialize

(

)

Referenced by sierra::nalu::Simulation::initialize(), and TimeIntegrator().

void sierra::nalu::TimeIntegrator::integrate_realm

(

)

References adaptiveTimeStep_, compute_gamma(), currentTime_, gamma1_, gamma2_, gamma3_, sierra::nalu::NaluEnv::naluOutputP0(), nonlinearIterations_, provide_mean_norm(), realmVec_, secondOrderTimeAccurate_, sierra::nalu::NaluEnv::self(), simulation_proceeds(), timeStepCount_, timeStepFromFile_, timeStepN_, and timeStepNm1_.

Referenced by sierra::nalu::Simulation::run(), and TimeIntegrator().

void sierra::nalu::TimeIntegrator::load

(

const YAML::Node &

node

)

References adaptiveTimeStep_, currentTime_, sierra::nalu::get_if_present(), maxTimeStepCount_, sierra::nalu::NaluEnv::naluOutputP0(), name_, nonlinearIterations_, realmNamesVec_, secondOrderTimeAccurate_, sierra::nalu::NaluEnv::self(), terminateBasedOnTime_, timeStepCount_, timeStepFromFile_, timeStepN_, timeStepNm1_, and totalSimTime_.

Referenced by sierra::nalu::Simulation::load(), unit_test_utils::NaluTest::NaluTest(), and TimeIntegrator().

Simulation * sierra::nalu::TimeIntegrator::parent

(

)

References sim_.

Referenced by root(), and TimeIntegrator().

void sierra::nalu::TimeIntegrator::provide_mean_norm

(

)

References currentTime_, sierra::nalu::NaluEnv::naluOutputP0(), realmVec_, sierra::nalu::NaluEnv::self(), and timeStepCount_.

Referenced by integrate_realm(), and TimeIntegrator().

Simulation * sierra::nalu::TimeIntegrator::root

(

)

References parent(), and sierra::nalu::Simulation::root().

Referenced by TimeIntegrator().

bool sierra::nalu::TimeIntegrator::simulation_proceeds

(

)

References currentTime_, maxTimeStepCount_, terminateBasedOnTime_, timeStepCount_, and totalSimTime_.

Referenced by integrate_realm(), and TimeIntegrator().

Member Data Documentation

bool sierra::nalu::TimeIntegrator::adaptiveTimeStep_

Referenced by get_is_fixed_time_step(), integrate_realm(), and load().

double sierra::nalu::TimeIntegrator::currentTime_

Referenced by get_current_time(), integrate_realm(), load(), provide_mean_norm(), and simulation_proceeds().

double sierra::nalu::TimeIntegrator::gamma1_

Referenced by compute_gamma(), get_gamma1(), integrate_realm(), and TEST_F().

double sierra::nalu::TimeIntegrator::gamma2_

Referenced by compute_gamma(), get_gamma2(), integrate_realm(), and TEST_F().

double sierra::nalu::TimeIntegrator::gamma3_

Referenced by compute_gamma(), get_gamma3(), integrate_realm(), and TEST_F().

int sierra::nalu::TimeIntegrator::maxTimeStepCount_

Referenced by get_max_time_step_count(), load(), and simulation_proceeds().

std::string sierra::nalu::TimeIntegrator::name_

Referenced by load().

int sierra::nalu::TimeIntegrator::nonlinearIterations_

Referenced by integrate_realm(), and load().

std::vector<std::string> sierra::nalu::TimeIntegrator::realmNamesVec_

Referenced by breadboard(), and load().

std::vector<Realm*> sierra::nalu::TimeIntegrator::realmVec_

Referenced by breadboard(), integrate_realm(), and provide_mean_norm().

bool sierra::nalu::TimeIntegrator::secondOrderTimeAccurate_

Referenced by integrate_realm(), load(), and sierra::nalu::Realm::number_of_states().

Simulation* sierra::nalu::TimeIntegrator::sim_ {nullptr}

Referenced by breadboard(), and parent().

bool sierra::nalu::TimeIntegrator::terminateBasedOnTime_

Referenced by get_is_terminate_based_on_time(), get_max_time_step_count(), get_total_sim_time(), load(), and simulation_proceeds().

int sierra::nalu::TimeIntegrator::timeStepCount_

Referenced by compute_gamma(), get_time_step_count(), integrate_realm(), load(), provide_mean_norm(), and simulation_proceeds().

double sierra::nalu::TimeIntegrator::timeStepFromFile_

Referenced by get_time_step_from_file(), integrate_realm(), and load().

double sierra::nalu::TimeIntegrator::timeStepN_

Referenced by compute_gamma(), get_time_step(), integrate_realm(), load(), and TEST_F().

double sierra::nalu::TimeIntegrator::timeStepNm1_

Referenced by compute_gamma(), get_time_step(), integrate_realm(), load(), and TEST_F().

double sierra::nalu::TimeIntegrator::totalSimTime_

Referenced by get_total_sim_time(), load(), and simulation_proceeds().

---

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

• TimeIntegrator.h
• TimeIntegrator.C