MultiApp that performs a time reset prior to solving, this enables the level set reinitialization to solve repeatedly. More...

#include <LevelSetReinitializationMultiApp.h>

Inheritance diagram for LevelSetReinitializationMultiApp:

[legend]

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	LevelSetReinitializationMultiApp (const InputParameters &parameters)

virtual void	initialSetup () override

virtual bool	solveStep (Real dt, Real target_time, bool auto_advance=true) override

virtual void	preExecute ()

virtual void	finalize ()

virtual void	postExecute ()

void	setupPositions ()

virtual void	createLocalApp (const unsigned int i)

virtual void	preTransfer (Real dt, Real target_time)

virtual void	incrementTStep (Real)

virtual void	finishStep (bool=false)

virtual void	backup ()

virtual void	restore (bool force=true)

bool	needsRestoration ()

virtual Executioner *	getExecutioner (unsigned int app)

virtual libMesh::BoundingBox	getBoundingBox (unsigned int app, bool displaced_mesh, const MultiAppCoordTransform *coord_transform=nullptr)

FEProblemBase &	problemBase ()

FEProblemBase &	appProblemBase (unsigned int app)

FEProblem &	appProblem (unsigned int app)

const UserObject &	appUserObjectBase (unsigned int app, const std::string &name)

Real	appPostprocessorValue (unsigned int app, const std::string &name)

virtual libMesh::NumericVector< libMesh::Number > &	appTransferVector (unsigned int app, std::string var_name)

unsigned int	numGlobalApps () const

unsigned int	numLocalApps ()

unsigned int	firstLocalApp ()

bool	isFirstLocalRank () const

bool	hasApp ()

bool	hasLocalApp (unsigned int global_app) const

MooseApp *	localApp (unsigned int local_app)

const Point &	position (unsigned int app) const

virtual void	resetApp (unsigned int global_app, Real time=0.0)

virtual void	moveApp (unsigned int global_app, Point p)

virtual void	parentOutputPositionChanged ()

MPI_Comm &	comm ()

const Parallel::Communicator &	comm () const

bool	isRootProcessor ()

bool	usingPositions () const

bool	runningInPosition () const

void	addAssociatedTransfer (MultiAppTransfer &transfer)

void	setAppOutputFileBase ()

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

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

bool	isKokkosObject (IsKokkosObjectKey &&) 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	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	mooseWarning (Args &&... args) const

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

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

void	mooseDeprecated (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

virtual void	timestepSetup ()

virtual void	jacobianSetup ()

virtual void	residualSetup ()

virtual void	subdomainSetup ()

virtual void	customSetup (const ExecFlagType &)

const ExecFlagEnum &	getExecuteOnEnum () const

PerfGraph &	perfGraph ()

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 void	transformBoundingBox (libMesh::BoundingBox &box, const MultiAppCoordTransform &transform)

Public Attributes
	usingCombinedWarningSolutionWarnings

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

static const std::string	kokkos_object_param

Protected Member Functions
void	setAppOutputFileBase (unsigned int index)

virtual std::vector< std::string >	cliArgs () const

virtual void	fillPositions ()

void	readCommandLineArguments ()

void	createApp (unsigned int i, Real start_time)

void	buildComm ()

unsigned int	globalAppToLocal (unsigned int global_app)

virtual void	preRunInputFile ()

virtual std::vector< std::string >	getCommandLineArgs (const unsigned int local_app)

void	init (unsigned int num_apps, bool batch_mode=false)

void	init (unsigned int num_apps, const LocalRankConfig &config)

void	createApps ()

void	keepSolutionDuringRestore (bool keep_solution_during_restore)

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) 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

Static Protected Member Functions
static std::string	getMultiAppName (const std::string &base_name, dof_id_type index, dof_id_type total)

Protected Attributes
LevelSetReinitializationProblem *	_level_set_problem
	Access to the level set specific problem to allow for the resetTime() method to be called. More...

Executioner *	_executioner
	Access to the Executioner object to call execute() More...

const unsigned int &	_interval
	The solve interval for reinitialization. More...

FEProblemBase &	_fe_problem

std::string	_app_type

std::vector< Point >	_positions

std::vector< const Positions *>	_positions_objs

std::vector< unsigned int >	_positions_index_offsets

const bool	_use_positions

std::vector< FileName >	_input_files

const bool &	_wait_for_first_app_init

std::vector< unsigned int >	_npositions_inputfile

std::string	_output_base

unsigned int	_total_num_apps

unsigned int	_my_num_apps

unsigned int	_first_local_app

const MPI_Comm &	_orig_comm

libMesh::Parallel::Communicator	_my_communicator

MPI_Comm &	_my_comm

int	_orig_num_procs

int	_orig_rank

std::string	_node_name

int	_my_rank

std::vector< std::shared_ptr< MooseApp > >	_apps

std::vector< bool >	_has_bounding_box

std::vector< libMesh::BoundingBox >	_bounding_box

Real	_inflation

Point	_bounding_box_padding

processor_id_type	_max_procs_per_app

processor_id_type	_min_procs_per_app

bool	_output_in_position

const Real	_global_time_offset

std::vector< Real >	_reset_times

std::vector< unsigned int >	_reset_apps

std::vector< bool >	_reset_happened

Real	_move_time

std::vector< unsigned int >	_move_apps

std::vector< Point >	_move_positions

bool	_move_happened

bool	_has_an_app

const std::vector< CLIArgString > &	_cli_args

std::vector< std::string >	_cli_args_from_file

bool	_keep_solution_during_restore

bool	_keep_aux_solution_during_restore

const bool	_no_restore

std::vector< std::vector< std::unique_ptr< libMesh::NumericVector< Real > > > >	_end_solutions

std::vector< std::unique_ptr< NumericVector< Real > > >	_end_aux_solutions

LocalRankConfig	_rank_config

std::vector< MultiAppTransfer *>	_associated_transfers

const bool	_run_in_position

SubAppBackups &	_sub_app_backups

const PerfID	_solve_step_timer

const PerfID	_init_timer

const PerfID	_backup_timer

const PerfID	_restore_timer

const PerfID	_reset_timer

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

const ExecFlagEnum &	_execute_enum

const ExecFlagType &	_current_execute_flag

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

MultiApp that performs a time reset prior to solving, this enables the level set reinitialization to solve repeatedly.

Definition at line 21 of file LevelSetReinitializationMultiApp.h.

Constructor & Destructor Documentation

◆ LevelSetReinitializationMultiApp()

LevelSetReinitializationMultiApp::LevelSetReinitializationMultiApp ( const InputParameters & parameters )

Definition at line 41 of file LevelSetReinitializationMultiApp.C.

   : MultiApp(parameters), _level_set_problem(NULL), _interval(getParam<unsigned int>("interval"))
 {
 }

Member Function Documentation

◆ initialSetup()

void LevelSetReinitializationMultiApp::initialSetup ( )

overridevirtual

Reimplemented from MultiApp.

Definition at line 48 of file LevelSetReinitializationMultiApp.C.

 {
   MultiApp::initialSetup();
 
   if (_has_an_app)
   {
     Executioner * ex = _apps[0]->getExecutioner();
 
     if (!ex)
       mooseError("Executioner does not exist!");
 
     ex->init();
 
     _executioner = ex;
 
     _level_set_problem = dynamic_cast<LevelSetReinitializationProblem *>(&appProblemBase(0));
     if (!_level_set_problem)
       mooseError("The Problem type must be LevelSetReinitializationProblem.");
   }
 }

◆ solveStep()

bool LevelSetReinitializationMultiApp::solveStep	(	Real	dt,
		Real	target_time,
		bool	auto_advance = `true`
	)

overridevirtual

Implements MultiApp.

Definition at line 70 of file LevelSetReinitializationMultiApp.C.

 {
   // Do nothing if not on interval
   if ((_fe_problem.timeStep() % _interval) != 0)
     return true;
 
   if (!_has_an_app)
     return true;
 
   _console << "Solving Reinitialization problem." << std::endl;
 
   int rank;
   int ierr;
   ierr = MPI_Comm_rank(_orig_comm, &rank);
   mooseCheckMPIErr(ierr);
 
   bool last_solve_converged = true;
 
   _level_set_problem->resetTime();
   _executioner->execute();
   if (!_executioner->lastSolveConverged())
     last_solve_converged = false;
 
   return last_solve_converged;
 }

◆ validParams()

InputParameters LevelSetReinitializationMultiApp::validParams ( )

static

Definition at line 21 of file LevelSetReinitializationMultiApp.C.

 {
   InputParameters params = MultiApp::validParams();
   params.addClassDescription(
       "MultiApp capable of performing repeated complete solves for level set reinitialization.");
   params.addParam<unsigned int>(
       "interval", 1, "Time step interval when to perform reinitialization.");
 
   params.suppressParameter<std::vector<Point>>("positions");
   params.suppressParameter<std::vector<FileName>>("positions_file");
   params.suppressParameter<bool>("output_in_position");
   params.suppressParameter<std::vector<Real>>("reset_time");
   params.suppressParameter<std::vector<unsigned int>>("reset_apps");
   params.suppressParameter<Real>("move_time");
   params.suppressParameter<std::vector<unsigned int>>("move_apps");
   params.suppressParameter<std::vector<Point>>("move_positions");
 
   return params;
 }