#include <RichardsTestApp.h>

Inheritance diagram for RichardsTestApp:

Public Member Functions
	RichardsTestApp (const InputParameters &parameters)

virtual	~RichardsTestApp ()

torch::DeviceType	getLibtorchDevice () const

TheWarehouse &	theWarehouse ()

virtual std::string	getPrintableName () const

virtual std::string	appBinaryName () const

int	exitCode () const

void	setExitCode (const int exit_code)

const InputParameters &	parameters ()

const RankMap &	rankMap ()

PerfGraph &	perfGraph ()

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

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

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

virtual void	run ()

std::string	getFrameworkVersion () const

virtual std::string	getVersion () const

std::string	getPrintableVersion () const

virtual void	setupOptions ()

ActionWarehouse &	actionWarehouse ()

const ActionWarehouse &	actionWarehouse () const

Moose::Builder &	builder ()

Syntax &	syntax ()

const std::vector< std::string > &	getInputFileNames () const

const std::string &	getLastInputFileName () const

void	setOutputFileBase (const std::string &output_file_base)

std::string	getOutputFileBase (bool for_non_moose_build_output=false) const

void	setOutputPosition (const Point &p)

std::list< std::string >	getCheckpointDirectories () const

std::list< std::string >	getCheckpointFiles () const

bool	hasOutputPosition () const

Point	getOutputPosition () const

void	setStartTime (Real time)

bool	hasStartTime () const

Real	getStartTime () const

void	setGlobalTimeOffset (Real offset)

Real	getGlobalTimeOffset () const

std::string	getFileName (bool stripLeadingPath=true) const

void	setErrorOverridden ()

void	disableCheckUnusedFlag ()

Executioner *	getExecutioner () const

Executor *	getExecutor () const

Executor &	getExecutor (const std::string &name, bool fail_if_not_found=true)

NullExecutor *	getNullExecutor () const

bool	useExecutor () const

FEProblemBase &	feProblem () const

void	setExecutioner (std::shared_ptr< Executioner > &&executioner)

void	setExecutor (std::shared_ptr< Executor > &&executor)

void	addExecutor (const std::string &type, const std::string &name, const InputParameters &params)

void	addExecutorParams (const std::string &type, const std::string &name, const InputParameters &params)

Parser &	parser ()

void	createExecutors ()

FixedPointConfig &	fixedPointConfig ()

bool &	useNonlinear ()

bool &	useEigenvalue ()

Factory &	getFactory ()

ActionFactory &	getActionFactory ()

processor_id_type	processor_id () const

std::shared_ptr< CommandLine >	commandLine () const

void	setExodusFileRestart (bool flag)

bool	getExodusFileRestart () const

void	setExReaderForRestart (std::shared_ptr< libMesh::ExodusII_IO > &&exreader)

libMesh::ExodusII_IO *	getExReaderForRestart () const

virtual void	runInputFile ()

virtual void	executeExecutioner ()

bool	getDistributedMeshOnCommandLine () const

bool	isRecovering () const

bool	isRestarting () const

bool	isSplitMesh () const

void	setRestartRecoverFileBase (const std::string &file_base)

bool	testCheckpointHalfTransient () const

void	setOutputFileNumbers (const std::map< std::string, unsigned int > &numbers)

const std::map< std::string, unsigned int > &	getOutputFileNumbers () const

OutputWarehouse &	getOutputWarehouse ()

const OutputWarehouse &	getOutputWarehouse () const

const SystemInfo *	getSystemInfo () const

std::string	appNameToLibName (const std::string &app_name) const

std::string	libNameToAppName (const std::string &library_name) const

std::set< std::string >	getLoadedLibraryPaths () const

std::set< std::string >	getLibrarySearchPaths (const std::string &library_path_from_param) const

InputParameterWarehouse &	getInputParameterWarehouse ()

RestartableDataValue &	registerRestartableData (std::unique_ptr< RestartableDataValue > data, THREAD_ID tid, bool read_only, const RestartableDataMapName &metaname="")

RestartableDataValue &	registerRestartableData (const std::string &name, std::unique_ptr< RestartableDataValue > data, THREAD_ID tid, bool read_only, const RestartableDataMapName &metaname="")

bool	hasRestartableMetaData (const std::string &name, const RestartableDataMapName &metaname) const

RestartableDataValue &	getRestartableMetaData (const std::string &name, const RestartableDataMapName &metaname, THREAD_ID tid)

void	possiblyLoadRestartableMetaData (const RestartableDataMapName &name, const std::filesystem::path &folder_base)

void	loadRestartableMetaData (const std::filesystem::path &folder_base)

std::vector< std::filesystem::path >	writeRestartableMetaData (const RestartableDataMapName &name, const std::filesystem::path &folder_base)

std::vector< std::filesystem::path >	writeRestartableMetaData (const std::filesystem::path &folder_base)

RestartableDataMap &	getRestartableDataMap (const RestartableDataMapName &name)

bool	hasRestartableDataMap (const RestartableDataMapName &name) const

void	registerRestartableDataMapName (const RestartableDataMapName &name, std::string suffix="")

const std::string &	getRestartableDataMapName (const RestartableDataMapName &name) const

const DataNames &	getRecoverableData () const

std::vector< std::filesystem::path >	backup (const std::filesystem::path &folder_base)

std::unique_ptr< Backup >	backup ()

virtual void	preBackup ()

void	restore (const std::filesystem::path &folder_base, const bool for_restart)

void	restore (std::unique_ptr< Backup > backup, const bool for_restart)

virtual void	postRestore (const bool)

void	restoreFromInitialBackup (const bool for_restart)

std::unique_ptr< Backup >	finalizeRestore ()

virtual std::string	header () const

unsigned int	multiAppLevel () const

unsigned int	multiAppNumber () const

bool	isUltimateMaster () const

bool	useMasterMesh () const

const MooseMesh *	masterMesh () const

const MooseMesh *	masterDisplacedMesh () const

MeshGeneratorSystem &	getMeshGeneratorSystem ()

ChainControlDataSystem &	getChainControlDataSystem ()

void	addMeshGenerator (const std::string &type, const std::string &name, const InputParameters &params)

bool	hasMeshGenerator (const MeshGeneratorName &name) const

const MeshGenerator &	getMeshGenerator (const std::string &name) const

std::unique_ptr< MeshBase >	getMeshGeneratorMesh ()

std::vector< std::string >	getMeshGeneratorNames () const

const MeshGenerator &	appendMeshGenerator (const std::string &type, const std::string &name, InputParameters params)

virtual bool	constructingMeshGenerators () const

bool	checkInput () const

bool	getFPTrapFlag () const

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

bool	addRelationshipManager (std::shared_ptr< RelationshipManager > relationship_manager)

std::filesystem::path	restartFolderBase (const std::filesystem::path &folder_base) const

const hit::Node *	getCurrentActionHitNode () const

void	attachRelationshipManagers (Moose::RelationshipManagerType rm_type, bool attach_geometric_rm_final=false)

void	attachRelationshipManagers (MeshBase &mesh, MooseMesh &moose_mesh)

const std::vector< std::shared_ptr< RelationshipManager > > &	getReleationshipManagers ()

std::vector< std::pair< std::string, std::string > >	getRelationshipManagerInfo () const

const ExecFlagEnum &	getExecuteOnEnum () const

bool	hasInitialBackup () const

bool	defaultAutomaticScaling () const

const std::shared_ptr< libMesh::Parallel::Communicator >	getCommunicator () const

const std::set< std::shared_ptr< RelationshipManager > > &	relationshipManagers () const

void	checkMetaDataIntegrity () const

virtual bool	errorOnJacobianNonzeroReallocation () const

void	registerInterfaceObject (T &interface)

const std::vector< T *> &	getInterfaceObjects () const

bool	forceRestart () const

bool	unusedFlagIsWarning () const

bool	unusedFlagIsError () 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

SolutionInvalidity &	solutionInvalidity ()

const SolutionInvalidity &	solutionInvalidity () const

SolutionInvalidity &	solutionInvalidity ()

const SolutionInvalidity &	solutionInvalidity () const

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

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

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

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

bool	hasRestartRecoverFileBase () const

bool	hasRestartRecoverFileBase () const

bool	hasRecoverFileBase () const

bool	hasRecoverFileBase () const

std::string	getRestartRecoverFileBase () const

std::string	getRestartRecoverFileBase () const

std::string	getRecoverFileBase () const

std::string	getRecoverFileBase () const

void	dynamicAllRegistration (const std::string &app_name, Factory factory, ActionFactory action_factory, Syntax *syntax, std::string library_path, const std::string &library_name)

void	dynamicAllRegistration (const std::string &app_name, Factory factory, ActionFactory action_factory, Syntax *syntax, std::string library_path, const std::string &library_name)

void	dynamicAppRegistration (const std::string &app_name, std::string library_path, const std::string &library_name, bool lib_load_deps)

void	dynamicAppRegistration (const std::string &app_name, std::string library_path, const std::string &library_name, bool lib_load_deps)

const std::vector< RestartableDataMap > &	getRestartableData () const

std::vector< RestartableDataMap > &	getRestartableData ()

const std::vector< RestartableDataMap > &	getRestartableData () const

std::vector< RestartableDataMap > &	getRestartableData ()

void	setRestart (bool value)

void	setRestart (bool value)

void	setRecover (bool value)

void	setRecover (bool value)

auto	getRestartableDataMapBegin ()

auto	getRestartableDataMapBegin ()

auto	getRestartableDataMapEnd ()

auto	getRestartableDataMapEnd ()

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

Static Public Member Functions
static InputParameters	validParams ()

static void	registerApps ()

static void	registerAll (Factory &f, ActionFactory &af, Syntax &s, bool use_test_objs=false)

static const std::string &	checkpointSuffix ()

static std::filesystem::path	metaDataFolderBase (const std::filesystem::path &folder_base, const std::string &map_suffix)

static void	addAppParam (InputParameters &params)

static void	addInputParam (InputParameters &params)

Public Attributes
const ConsoleStream	_console

Static Public Attributes
static const RestartableDataMapName	MESH_META_DATA

static const std::string	MESH_META_DATA_SUFFIX

Protected Types
enum	UNUSED_CHECK

Protected Member Functions
void	dynamicRegistration (const libMesh::Parameters &params)

void	loadLibraryAndDependencies (const std::string &library_filename, const libMesh::Parameters &params, bool load_dependencies=true)

void	registerRestartableNameWithFilter (const std::string &name, Moose::RESTARTABLE_FILTER filter)

void	errorCheck ()

void	outputMachineReadableData (const std::string &param, const std::string &start_marker, const std::string &end_marker, const std::string &data) 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 void	addCapability (const std::string &capability, CapabilityUtils::Type value, const std::string &doc)

static void	addCapability (const std::string &capability, const char *value, const std::string &doc)

static void	addCapability (const std::string &capability, CapabilityUtils::Type value, const std::string &doc)

static void	addCapability (const std::string &capability, const char *value, const std::string &doc)

Protected Attributes
	OFF

	WARN_UNUSED

	ERROR_UNUSED

const InputParameters &	_pars

const std::string	_type

const std::shared_ptr< libMesh::Parallel::Communicator >	_comm

std::string	_output_file_base

bool	_file_base_set_by_user

bool	_output_position_set

Point	_output_position

bool	_start_time_set

Real	_start_time

Real	_global_time_offset

std::shared_ptr< CommandLine >	_command_line

Syntax	_syntax

std::unique_ptr< InputParameterWarehouse >	_input_parameter_warehouse

ActionFactory	_action_factory

ActionWarehouse	_action_warehouse

OutputWarehouse	_output_warehouse

const std::shared_ptr< Parser >	_parser

Moose::Builder	_builder

std::vector< RestartableDataMap >	_restartable_data

DataNames	_recoverable_data_names

PerfGraph &	_perf_graph

SolutionInvalidity &	_solution_invalidity

const RankMap	_rank_map

std::shared_ptr< Executioner >	_executioner

std::shared_ptr< Executor >	_executor

std::map< std::string, std::shared_ptr< Executor > >	_executors

std::unordered_map< std::string, std::pair< std::string, std::unique_ptr< InputParameters > > >	_executor_params

FixedPointConfig	_fixed_point_config

const bool	_use_executor

std::shared_ptr< NullExecutor >	_null_executor

bool	_use_nonlinear

bool	_use_eigen_value

std::unique_ptr< SystemInfo >	_sys_info

enum MooseApp::UNUSED_CHECK	_enable_unused_check

Factory	_factory

bool	_error_overridden

std::string	_early_exit_param

bool	_ready_to_exit

int	_exit_code

bool	_initial_from_file

std::shared_ptr< libMesh::ExodusII_IO >	_ex_reader

bool	_distributed_mesh_on_command_line

bool	_recover

bool	_restart

bool	_split_mesh

const bool	_use_split

const bool	_force_restart

bool	_trap_fpe

std::string	_restart_recover_base

bool	_test_checkpoint_half_transient

std::map< std::string, unsigned int >	_output_file_numbers

bool	_check_input

std::set< std::shared_ptr< RelationshipManager > >	_relationship_managers

std::map< Moose::RelationshipManagerType, std::set< const RelationshipManager *> >	_attached_relationship_managers

std::unordered_map< RelationshipManager *, std::shared_ptr< libMesh::GhostingFunctor > >	_undisp_to_disp_rms

std::unordered_map< std::string, DynamicLibraryInfo >	_lib_handles

MooseApp &	_pg_moose_app

const std::string	_prefix

MooseApp &	_app

const std::string	_name

const Parallel::Communicator &	_communicator

Detailed Description

Definition at line 14 of file RichardsTestApp.h.

Constructor & Destructor Documentation

◆ RichardsTestApp()

RichardsTestApp::RichardsTestApp ( const InputParameters & parameters )

Definition at line 25 of file RichardsTestApp.C.

                                                                    : MooseApp(parameters)
 {
   mooseDeprecated("Please use the PorousFlow module instead.  If Richards contains functionality "
                   "not included in PorousFlow, please contact the moose-users google group");
   RichardsTestApp::registerAll(
       _factory, _action_factory, _syntax, getParam<bool>("allow_test_objects"));
 }

◆ ~RichardsTestApp()

RichardsTestApp::~RichardsTestApp ( )

virtual

Definition at line 33 of file RichardsTestApp.C.

33 {}

Member Function Documentation

◆ registerAll()

void RichardsTestApp::registerAll	(	Factory &	f,
		ActionFactory &	af,
		Syntax &	s,
		bool	use_test_objs = `false`
	)

static

Definition at line 36 of file RichardsTestApp.C.

Referenced by CombinedTestApp::registerAll(), RichardsTestApp(), and RichardsTestApp__registerAll().

 {
   RichardsApp::registerAll(f, af, s);
   if (use_test_objs)
   {
     Registry::registerObjectsTo(f, {"RichardsTestApp"});
     Registry::registerActionsTo(af, {"RichardsTestApp"});
   }
 }

◆ registerApps()

void RichardsTestApp::registerApps ( )

static

Definition at line 47 of file RichardsTestApp.C.

Referenced by CombinedTestApp::registerApps(), and RichardsTestApp__registerApps().

 {
   RichardsApp::registerApps();
   registerApp(RichardsTestApp);
 }

◆ validParams()

InputParameters RichardsTestApp::validParams ( )

static

Definition at line 17 of file RichardsTestApp.C.

 {
   InputParameters params = RichardsApp::validParams();
   return params;
 }

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

richards/test/include/base/RichardsTestApp.h
richards/test/src/base/RichardsTestApp.C

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RichardsTestApp()

◆ ~RichardsTestApp()

Member Function Documentation

◆ registerAll()

◆ registerApps()

◆ validParams()