ExternalPetscSolverApp Class Reference

This is a demo used to demonstrate how to couple an external app through the MOOSE wrapper APP. More...

#include <ExternalPetscSolverApp.h>

Inheritance diagram for ExternalPetscSolverApp:

Public Member Functions
	ExternalPetscSolverApp (InputParameters parameters)
virtual	~ExternalPetscSolverApp ()
TS &	getExternalPETScTS ()
	Return a time-stepping (TS) component that holds all the ingredients of applicaiton. More...

Static Public Member Functions
static void	registerApps ()
static void	registerAll (Factory &f, ActionFactory &af, Syntax &s)

Private Attributes
TS	_ts
	Time-stepping (TS) object. More...

Detailed Description

This is a demo used to demonstrate how to couple an external app through the MOOSE wrapper APP.

We are using a PETSc application as an example. ExternalPetscSolverApp create and destroys an external PETSc FEM/FDM solver.

Definition at line 25 of file ExternalPetscSolverApp.h.

Constructor & Destructor Documentation

ExternalPetscSolverApp()

ExternalPetscSolverApp::ExternalPetscSolverApp

(

InputParameters

parameters

)

Definition at line 24 of file ExternalPetscSolverApp.C.

                                                                         : MooseApp(parameters)
{
  ExternalPetscSolverApp::registerAll(_factory, _action_factory, _syntax);
 
#if LIBMESH_HAVE_PETSC
  PETScExternalSolverCreate(_comm->get(), &_ts);
#else
  mooseError("You need to have PETSc installed to use ExternalPETScApp");
#endif
}

~ExternalPetscSolverApp()

ExternalPetscSolverApp::~ExternalPetscSolverApp ( )

virtual

Definition at line 35 of file ExternalPetscSolverApp.C.

{
#if LIBMESH_HAVE_PETSC
  PETScExternalSolverDestroy(_ts);
#endif
}

Member Function Documentation

getExternalPETScTS()

TS& ExternalPetscSolverApp::getExternalPETScTS ( )

inline

Return a time-stepping (TS) component that holds all the ingredients of applicaiton.

Definition at line 38 of file ExternalPetscSolverApp.h.

{ return _ts; }

Referenced by PETScDMDAMesh::PETScDMDAMesh().

registerAll()

void ExternalPetscSolverApp::registerAll ( Factory &  f, ActionFactory &  af, Syntax &  s  )

static

Definition at line 43 of file ExternalPetscSolverApp.C.

{
  Registry::registerObjectsTo(f, {"ExternalPetscSolverApp"});
  Registry::registerActionsTo(af, {"ExternalPetscSolverApp"});
 
  /* register custom execute flags, action syntax, etc. here */
}

Referenced by ExternalPetscSolverApp(), ExternalPetscSolverApp__registerAll(), ExternalPetscSolverTestApp::registerAll(), CombinedTestApp::registerAll(), CombinedApp::registerAll(), and ModulesApp::registerAll().

registerApps()

void ExternalPetscSolverApp::registerApps ( )

static

Definition at line 52 of file ExternalPetscSolverApp.C.

{
  registerApp(ExternalPetscSolverApp);
}

Referenced by ExternalPetscSolverApp__registerApps().

Member Data Documentation

_ts

TS ExternalPetscSolverApp::_ts

private

Time-stepping (TS) object.

Definition at line 43 of file ExternalPetscSolverApp.h.

Referenced by ExternalPetscSolverApp(), getExternalPETScTS(), and ~ExternalPetscSolverApp().

---

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

• external_petsc_solver/include/base/ExternalPetscSolverApp.h
• external_petsc_solver/src/base/ExternalPetscSolverApp.C