Class for output data to the ExodusII format. More...

#include <ExodusOptimizationSteady.h>

Inheritance diagram for ExodusOptimizationSteady:

Public Types
enum	OutputDimension { OutputDimension::DEFAULT, OutputDimension::ONE, OutputDimension::TWO, OutputDimension::THREE, OutputDimension::PROBLEM_DIMENSION }

typedef DataFileName	DataFileParameterType

Public Member Functions
	ExodusOptimizationSteady (const InputParameters &parameters)
	Class constructor. More...

virtual void	output () override

virtual void	initialSetup () override

virtual void	meshChanged () override

virtual void	outputSetup ()

virtual void	sequence (bool state)

void	setOutputDimension (unsigned int dim)

void	clear ()

bool	supportsMaterialPropertyOutput () const override

virtual void	outputStep (const ExecFlagType &type) override

virtual bool	hasOutput ()

bool	hasOutput (const ExecFlagType &type)

bool	hasNodalVariableOutput ()

const std::set< std::string > &	getNodalVariableOutput ()

bool	hasElementalVariableOutput ()

const std::set< std::string > &	getElementalVariableOutput ()

bool	hasScalarOutput ()

const std::set< std::string > &	getScalarOutput ()

bool	hasPostprocessorOutput ()

const std::set< std::string > &	getPostprocessorOutput ()

bool	hasVectorPostprocessorOutput ()

const std::set< std::string > &	getVectorPostprocessorOutput ()

bool	hasReporterOutput ()

const std::set< std::string > &	getReporterOutput ()

const OutputOnWarehouse &	advancedExecuteOn () const

void	setFileBase (const std::string &file_base)

void	setFileNumber (unsigned int num)

unsigned int	getFileNumber ()

virtual Real	time () override

virtual Real	timeOld ()

virtual Real	dt ()

virtual Real	dtOld ()

virtual int	timeStep ()

const unsigned int &	interval () const

const MultiMooseEnum &	executeOn () const

bool	isAdvanced ()

void	allowOutput (bool state)

const std::set< Real > &	getSyncTimes ()

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

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

MooseApp &	getMooseApp () const

const std::string &	type () const

virtual const std::string &	name () const

std::string	typeAndName () const

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

void	callMooseError (std::string msg, const bool with_prefix) const

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

const InputParameters &	parameters () const

MooseObjectName	uniqueName () 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 &nm) 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

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

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

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

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

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

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

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

void	mooseInfo (Args &&... args) 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

virtual void	timestepSetup ()

virtual void	jacobianSetup ()

virtual void	residualSetup ()

virtual void	subdomainSetup ()

virtual void	customSetup (const ExecFlagType &)

const ExecFlagEnum &	getExecuteOnEnum () const

const Function &	getFunction (const std::string &name) const

const Function &	getFunctionByName (const FunctionName &name) const

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

bool	hasFunctionByName (const FunctionName &name) 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

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const

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

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name) const

const VectorPostprocessorName &	getVectorPostprocessorName (const std::string &param_name) const

PerfGraph &	perfGraph ()

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

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

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

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

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	setOutputDimensionInExodusWriter (libMesh::ExodusII_IO &exodus_io, const MooseMesh &mesh, OutputDimension output_dim=OutputDimension::DEFAULT)

static InputParameters	enableOutputTypes (const std::string &names=std::string())

static ExecFlagEnum	getDefaultExecFlagEnum ()

static void	addDeprecatedInputParameters (InputParameters &params)

Public Attributes
const ConsoleStream	_console

Protected Member Functions
void	customizeFileOutput () override
	Customize file output with steady and adjoint iteration number. More...

virtual Real	getOutputTime () override
	Get time for output (i.e. More...

virtual void	outputNodalVariables () override

virtual void	outputElementalVariables () override

virtual void	outputPostprocessors () override

virtual void	outputScalarVariables () override

virtual void	outputInput () override

virtual void	outputReporters () override

virtual std::string	filename () override

virtual void	updateSample ()

virtual void	setFileBaseInternal (const std::string &file_base) override

virtual void	init ()

virtual bool	shouldOutput ()

virtual void	outputVectorPostprocessors ()

virtual void	outputSystemInformation ()

bool	checkFilename ()

bool	inNonlinearTimeWindow ()

bool	inLinearTimeWindow ()

virtual bool	onInterval ()

void	setWallTimeIntervalFromCommandLineParam ()

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

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &) const

virtual void	addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &) const

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

virtual void	addReporterDependencyHelper (const ReporterName &)

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

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

Static Protected Member Functions
static PetscErrorCode	petscNonlinearOutput (SNES, PetscInt its, PetscReal fnorm, void *void_ptr)

static PetscErrorCode	petscLinearOutput (KSP, PetscInt its, PetscReal fnorm, void *void_ptr)

Protected Attributes
std::unique_ptr< libMesh::ExodusII_IO >	_exodus_io_ptr

std::vector< Real >	_global_values

std::vector< std::string >	_global_names

bool	_exodus_initialized

bool &	_exodus_mesh_changed

bool	_sequence

unsigned int &	_exodus_num

const unsigned int	_refinements

const bool	_using_external_sampling_file

const bool	_change_position

bool	_use_sampled_output

bool	_elemental_as_nodal

bool	_scalar_as_nodal

const ReporterData &	_reporter_data

unsigned int &	_file_num

unsigned int	_padding

std::vector< std::string >	_output_if_base_contains

std::string	_file_base

Real	_norm

PetscInt	_nonlinear_iter

PetscInt	_linear_iter

bool	_on_linear_residual

bool	_on_nonlinear_residual

FEProblemBase *	_problem_ptr

bool	_transient

bool	_use_displaced

libMesh::EquationSystems *	_es_ptr

MooseMesh *	_mesh_ptr

ExecFlagEnum	_execute_on

ExecFlagType	_current_execute_flag

Real &	_time

Real &	_time_old

int &	_t_step

Real &	_dt

Real &	_dt_old

unsigned int	_num

const bool	_time_step_interval_set_by_addparam

unsigned int	_time_step_interval

const Real	_min_simulation_time_interval

const Real	_simulation_time_interval

Real	_wall_time_interval

std::set< Real >	_sync_times

const Times *const	_sync_times_object

Real	_start_time

Real	_end_time

int	_start_step

int	_end_step

Real	_t_tol

bool	_sync_only

bool	_allow_output

bool	_is_advanced

OutputOnWarehouse	_advanced_execute_on

Real &	_last_output_simulation_time

std::chrono::time_point< std::chrono::steady_clock >	_last_output_wall_time

Real	_wall_time_since_last_output

const bool &	_enabled

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

FEProblemBase &	_mci_feproblem

const ExecFlagEnum &	_execute_enum

MooseApp &	_pg_moose_app

const std::string	_prefix

PetscOutput *	_petsc_output

const Parallel::Communicator &	_communicator

Private Attributes
const Steady *const	_steady_exec
	For steady (and steady and adjoint) executioner. More...

Detailed Description

Class for output data to the ExodusII format.

Definition at line 19 of file ExodusOptimizationSteady.h.

Constructor & Destructor Documentation

◆ ExodusOptimizationSteady()

ExodusOptimizationSteady::ExodusOptimizationSteady ( const InputParameters & parameters )

Class constructor.

Definition at line 25 of file ExodusOptimizationSteady.C.

   : Exodus(parameters), _steady_exec(dynamic_cast<Steady *>(_app.getExecutioner()))
 {
   if (!_steady_exec)
     mooseError(
         "ExodusOptimizationSteady output can only be used with the SteadyAndAdjoint or Steady"
         "executioners to output a per-optimization iteration solution.");
 }

Member Function Documentation

◆ customizeFileOutput()

void ExodusOptimizationSteady::customizeFileOutput ( )

overrideprotectedvirtual

Customize file output with steady and adjoint iteration number.

Reimplemented from Exodus.

Definition at line 35 of file ExodusOptimizationSteady.C.

 {
   if (_exodus_mesh_changed || _sequence)
     _file_num++;
 
   _exodus_num = _steady_exec->getIterationNumberOutput() + 1;
 
   if (_exodus_num == 1)
     _exodus_io_ptr->append(false);
   else
     _exodus_io_ptr->append(true);
 }

◆ getOutputTime()

Real ExodusOptimizationSteady::getOutputTime ( )

overrideprotectedvirtual

Get time for output (i.e.

iteration number for optimization solves).

Reimplemented from Exodus.

Definition at line 49 of file ExodusOptimizationSteady.C.

 {
   return _steady_exec->getIterationNumberOutput();
 }

◆ validParams()

InputParameters ExodusOptimizationSteady::validParams ( )

static

Definition at line 15 of file ExodusOptimizationSteady.C.

 {
   // Get the base class parameters
   InputParameters params = Exodus::validParams();
   params.set<ExecFlagEnum>("execute_on") = EXEC_TIMESTEP_END;
 
   // Return the InputParameters
   return params;
 }

Member Data Documentation

◆ _steady_exec

const Steady* const ExodusOptimizationSteady::_steady_exec

private

For steady (and steady and adjoint) executioner.

Definition at line 42 of file ExodusOptimizationSteady.h.

Referenced by customizeFileOutput(), ExodusOptimizationSteady(), and getOutputTime().

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

optimization/include/outputs/ExodusOptimizationSteady.h
optimization/src/outputs/ExodusOptimizationSteady.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Attributes