#include <TransientAndAdjoint.h>

Inheritance diagram for TransientAndAdjoint:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	TransientAndAdjoint (const InputParameters &parameters)

virtual void	preExecute () override
	For storing the initial condition. More...

virtual void	postStep () override
	For storing the converged solution. More...

virtual void	postExecute () override
	For solving the adjoint problem. More...

virtual void	init () override

virtual Real	relativeSolutionDifferenceNorm (bool check_aux) const override

virtual void	execute () override

virtual void	takeStep (Real input_dt=-1.0)

virtual Real	computeConstrainedDT ()

virtual void	estimateTimeError ()

virtual Real	getDT ()

virtual bool	keepGoing ()

virtual bool	lastSolveConverged () const override

void	computeDT ()

virtual void	preStep ()

virtual void	incrementStepOrReject ()

virtual void	endStep (Real input_time=-1.0)

virtual void	setTargetTime (Real target_time)

virtual Real	getTime () const

virtual Real	getTargetTime ()

virtual void	setTime (Real t)

virtual void	setTimeOld (Real t)

Real	computeSolutionChangeNorm (bool check_aux, bool normalize_by_dt) const

TimeStepper *	getTimeStepper ()

const TimeStepper *	getTimeStepper () const

void	setTimeStepper (TimeStepper &ts)

virtual std::string	getTimeStepperName () const override

virtual std::vector< std::string >	getTimeIntegratorNames () const override

Moose::TimeIntegratorType	getTimeScheme () const

std::set< Real > &	syncTimes ()

Real &	dtMax ()

Real &	dtMin ()

Real	getStartTime () const

Real	getEndTime () const

Real &	endTime ()

Real &	timestepTol ()

virtual void	setTimestepTolerance (const Real &tolerance)

bool	atSyncPoint ()

Real	unconstrainedDT ()

void	parentOutputPositionChanged () override

virtual void	forceNumSteps (const unsigned int num_steps)

virtual SolveObject *	timeStepSolveObject ()

bool	convergedToSteadyState () const

virtual void	preProblemInit ()

virtual void	preSolve ()

virtual void	postSolve ()

virtual Problem &	problem ()

FEProblemBase &	feProblem ()

FixedPointSolve &	fixedPointSolve ()

const bool &	verbose () const

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &name) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const

void	mooseError (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

UserObjectName	getUserObjectName (const std::string &param_name) const

const T &	getUserObject (const std::string &param_name, bool is_dependency=true) const

const T &	getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const

const UserObject &	getUserObjectBase (const std::string &param_name, bool is_dependency=true) const

const UserObject &	getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const

bool	isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

bool	hasPostprocessor (const std::string &param_name, const unsigned int index=0) const

bool	hasPostprocessorByName (const PostprocessorName &name) const

std::size_t	coupledPostprocessors (const std::string &param_name) const

const PostprocessorName &	getPostprocessorName (const std::string &param_name, const unsigned int index=0) const

PerfGraph &	perfGraph ()

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const

virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const

virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

virtual void	store (nlohmann::json &json) const

virtual bool	shouldStore () const

virtual void	declareLateValues ()

void	buildOutputHideVariableList (std::set< std::string > variable_names)

const std::set< OutputName > &	getOutputs ()

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node)

static InputParameters	defaultSteadyStateConvergenceParams ()

static MooseEnum	iterationMethods ()

Public Attributes
const ConsoleStream	_console

Static Public Attributes
static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

Protected Member Functions
virtual std::set< TimeIntegrator *>	getTimeIntegrators () const override

void	setupTimeIntegrator ()

virtual PostprocessorValue &	addAttributeReporter (const std::string &name, Real initial_value=0)

virtual void	addUserObjectDependencyHelper (const UserObject &) const

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &) const

T &	declareRestartableData (const std::string &data_name, Args &&... args)

ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

const T &	getRestartableData (const std::string &data_name) const

T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

T &	declareRecoverableData (const std::string &data_name, Args &&... args)

T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)

T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)

std::string	restartableName (const std::string &data_name) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_name) const

T &	declareUnusedValue (Args &&... args)

const ReporterContextBase &	getReporterContextBaseByName (const ReporterName &reporter_name) const

const ReporterName &	getReporterName (const std::string &param_name) const

virtual void	addReporterDependencyHelper (const ReporterName &)

T &	declareValue (const std::string &param_name, Args &&... args)

T &	declareValue (const std::string &param_name, ReporterMode mode, Args &&... args)

T &	declareValue (const std::string &param_name, Args &&... args)

T &	declareValue (const std::string &param_name, ReporterMode mode, Args &&... args)

T &	declareValue (const std::string &param_name, Args &&... args)

T &	declareValue (const std::string &param_name, ReporterMode mode, Args &&... args)

T &	declareValue (const std::string &param_name, Args &&... args)

T &	declareValue (const std::string &param_name, ReporterMode mode, Args &&... args)

T &	declareValueByName (const ReporterValueName &value_name, Args &&... args)

T &	declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args)

T &	declareValueByName (const ReporterValueName &value_name, Args &&... args)

T &	declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args)

T &	declareValueByName (const ReporterValueName &value_name, Args &&... args)

T &	declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args)

T &	declareValueByName (const ReporterValueName &value_name, Args &&... args)

T &	declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args)

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

Protected Attributes
AdjointTransientSolve	_adjoint_solve
	The transient adjoint solve object responsible for storing forward solutions and solving the adjoint system. More...

std::vector< Real > &	_forward_times
	Cached forward time points so we can properly loop backward in time. More...

FEProblemSolve	_feproblem_solve

FEProblemBase &	_problem

AuxiliarySystem &	_aux

Moose::TimeIntegratorType	_time_scheme

TimeStepper *	_time_stepper

int &	_t_step

Real &	_time

Real &	_time_old

Real &	_dt

Real &	_dt_old

Real &	_unconstrained_dt

bool &	_at_sync_point

bool &	_last_solve_converged

bool	_xfem_repeat_step

Real	_end_time

Real	_dtmin

Real	_dtmax

unsigned int	_num_steps

int	_n_startup_steps

const bool	_steady_state_detection

const Real	_steady_state_start_time

std::set< Real > &	_sync_times

bool	_abort

const bool	_error_on_dtmin

bool &	_time_interval

Real	_next_interval_output_time

Real	_time_interval_output_interval

Real	_start_time

Real	_timestep_tolerance

Real &	_target_time

bool	_use_multiapp_dt

FEProblemBase &	_fe_problem

MooseEnum	_iteration_method

std::unique_ptr< FixedPointSolve >	_fixed_point_solve

std::string	_restart_file_base

const bool &	_verbose

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

MooseApp &	_pg_moose_app

const std::string	_prefix

const Parallel::Communicator &	_communicator

Detailed Description

Definition at line 18 of file TransientAndAdjoint.h.

Constructor & Destructor Documentation

◆ TransientAndAdjoint()

TransientAndAdjoint::TransientAndAdjoint ( const InputParameters & parameters )

Definition at line 38 of file TransientAndAdjoint.C.

   : Transient(parameters),
     _adjoint_solve(*this),
     _forward_times(declareRecoverableData<std::vector<Real>>("forward_times"))
 {
   // Error out on unsupported time integration schemes
   switch (getTimeScheme())
   {
     case Moose::TI_IMPLICIT_EULER:
       break;
     default:
       paramError(
           "scheme", getParam<MooseEnum>("scheme"), " is not supported for computing adjoint.");
       break;
   }
 }

Member Function Documentation

◆ postExecute()

void TransientAndAdjoint::postExecute ( )

overridevirtual

For solving the adjoint problem.

Reimplemented from Transient.

Definition at line 85 of file TransientAndAdjoint.C.

 {
   Transient::postExecute();
 
   // If it is a half transient, then the app is meant to be run with recovery. Therefore, it doesn't
   // make sense to run the adjoint calculation since we aren't getting to the final time required
   // for a consistent adjoint.
   if (_app.testCheckpointHalfTransient())
     return;
 
   // Looping backward through forward time steps
   for (const auto n : make_range(_forward_times.size() - 1))
   {
     // Set important time information so the Jacobian is properly computed in the forward system
     _t_step = _forward_times.size() - 1 - n;
     _time = _forward_times[_t_step];
     _time_old = _forward_times[_t_step - 1];
     _dt = _time - _time_old;
     _dt_old = _t_step < 2 ? _dt : _time_old - _forward_times[_t_step - 2];
 
     // Set the forward solution to the time step that is currently being solved
     _adjoint_solve.setForwardSolution(_t_step);
 
     // Incase there are some residual objects that need this call
     _problem.timestepSetup();
     _problem.onTimestepBegin();
 
     // Solve the adjoint system
     _last_solve_converged = _adjoint_solve.solve();
     if (!lastSolveConverged())
       break;
 
     // FIXME: This works well enough for console and CSV output, but exodus is a mess since I don't
     // think it knows what to do with backward timestepping or duplicate outputs at a given time
     _problem.outputStep(OptimizationAppTypes::EXEC_ADJOINT_TIMESTEP_END);
   }
 }

◆ postStep()

void TransientAndAdjoint::postStep ( )

overridevirtual

For storing the converged solution.

Reimplemented from Transient.

Definition at line 72 of file TransientAndAdjoint.C.

 {
   Transient::postStep();
 
   // Save the converged forward solution and time
   if (lastSolveConverged())
   {
     _adjoint_solve.insertForwardSolution(_t_step);
     _forward_times.push_back(_time);
   }
 }

◆ preExecute()

void TransientAndAdjoint::preExecute ( )

overridevirtual

For storing the initial condition.

Reimplemented from Transient.

Definition at line 56 of file TransientAndAdjoint.C.

 {
   Transient::preExecute();
 
   // Save the forward initial condition
   _adjoint_solve.insertForwardSolution(_t_step);
 
   // Save the time of the initial condition
   // The vector of times should be reset unless we are recovering
   if (!_app.isRecovering())
     _forward_times = {_time};
   else
     _forward_times.push_back(_time);
 }

◆ validParams()

InputParameters TransientAndAdjoint::validParams ( )

static

Definition at line 18 of file TransientAndAdjoint.C.

 {
   InputParameters params = Transient::validParams();
   params += AdjointTransientSolve::validParams();
   params.addClassDescription("Executioner for evaluating transient simulations and their adjoint.");
 
   // We need to full matrix for the adjoint solve, so set this to NEWTON
   params.set<MooseEnum>("solve_type") = "newton";
   params.suppressParameter<MooseEnum>("solve_type");
 
   // The adjoint system (second one) is solved by _adjoint_solve
   // This is a parameter of the MultiSystemSolveObject, which we set from here, the executioner.
   // We seek to prevent the MultiSystemSolveObject from solving both systems
   // This is abusing input parameters, but SolveObjects do not have their own syntax
   // and we need to send this parameter from the executioner to the default nested SolveObject
   params.renameParam("system_names", "forward_system", "");
 
   return params;
 }

Member Data Documentation

◆ _adjoint_solve

AdjointTransientSolve TransientAndAdjoint::_adjoint_solve

protected

The transient adjoint solve object responsible for storing forward solutions and solving the adjoint system.

Definition at line 42 of file TransientAndAdjoint.h.

Referenced by postExecute(), postStep(), and preExecute().

◆ _forward_times

std::vector<Real>& TransientAndAdjoint::_forward_times

protected

Cached forward time points so we can properly loop backward in time.

Definition at line 44 of file TransientAndAdjoint.h.

Referenced by postExecute(), postStep(), and preExecute().

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

optimization/include/executioners/TransientAndAdjoint.h
optimization/src/executioners/TransientAndAdjoint.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TransientAndAdjoint()

Member Function Documentation

◆ postExecute()

◆ postStep()

◆ preExecute()

◆ validParams()

Member Data Documentation

◆ _adjoint_solve

◆ _forward_times