ExternalPETScProblem Class Reference

This is an interface to call a pure PETSc solver. More...

#include <ExternalPETScProblem.h>

Inheritance diagram for ExternalPETScProblem:

Public Member Functions
	ExternalPETScProblem (const InputParameters &params)
	~ExternalPETScProblem ()
virtual void	externalSolve () override
virtual void	syncSolutions (Direction) override
virtual bool	converged () override

Private Attributes
const VariableName &	_sync_to_var_name
	The name of the variable to transfer to. More...
ExternalPetscSolverApp &	_petsc_app
TS &	_ts
	PETSc solver. More...
Vec	_petsc_sol
	PETSc solver solution. More...

Detailed Description

This is an interface to call a pure PETSc solver.

We also sync the PETSc solution to moose variables, and then these variables can be coupled to other moose applications

Definition at line 27 of file ExternalPETScProblem.h.

Constructor & Destructor Documentation

ExternalPETScProblem()

ExternalPETScProblem::ExternalPETScProblem

(

const InputParameters &

params

)

Definition at line 25 of file ExternalPETScProblem.C.

  : ExternalProblem(params),
    _sync_to_var_name(getParam<VariableName>("sync_variable")),
    // ExternalPETScProblem always requires ExternalPetscSolverApp
    _petsc_app(static_cast<ExternalPetscSolverApp &>(_app))
#if LIBMESH_HAVE_PETSC
    ,
    _ts(_petsc_app.getExternalPETScTS())
{
  DM da;
  TSGetDM(_ts, &da);
  DMCreateGlobalVector(da, &_petsc_sol);
  FormInitialSolution(_ts, _petsc_sol, NULL);
}

~ExternalPETScProblem()

ExternalPETScProblem::~ExternalPETScProblem ( )

inline

Definition at line 32 of file ExternalPETScProblem.h.

{ VecDestroy(&_petsc_sol); }

Member Function Documentation

converged()

virtual bool ExternalPETScProblem::converged ( )

inlineoverridevirtual

Definition at line 38 of file ExternalPETScProblem.h.

{ return true; }

externalSolve()

void ExternalPETScProblem::externalSolve ( )

overridevirtual

Initial value:

{
  mooseError("You need to have PETSc installed to use ExternalPETScProblem")

Definition at line 46 of file ExternalPETScProblem.C.

{
#if LIBMESH_HAVE_PETSC
  _console << "PETSc External Solve!" << std::endl;
  externalPETScDiffusionFDMSolve(_ts, _petsc_sol, dt(), time());
#endif
}

syncSolutions()

void ExternalPETScProblem::syncSolutions ( Direction  direction )

overridevirtual

Definition at line 55 of file ExternalPETScProblem.C.

{
#if LIBMESH_HAVE_PETSC
  if (direction == Direction::FROM_EXTERNAL_APP)
  {
    _console << "syncSolutions from external petsc App" << std::endl;
    DM da;
    // xs: start grid point in x direction on local
    // ys: start grid point in y direciton on local
    // xm: number of grid points in x direciton on local
    // ym: number of grid points in y direction on local
    // Mx: number of grid points in x direction on all processors
    PetscInt i, j, xs, ys, xm, ym, Mx;
    PetscScalar ** _petsc_sol_array;
    TSGetDM(_ts, &da);
    DMDAGetInfo(da,
                PETSC_IGNORE,
                &Mx,
                PETSC_IGNORE,
                PETSC_IGNORE,
                PETSC_IGNORE,
                PETSC_IGNORE,
                PETSC_IGNORE,
                PETSC_IGNORE,
                PETSC_IGNORE,
                PETSC_IGNORE,
                PETSC_IGNORE,
                PETSC_IGNORE,
                PETSC_IGNORE);
    DMDAGetCorners(da, &xs, &ys, NULL, &xm, &ym, NULL);
    DMDAVecGetArray(da, _petsc_sol, &_petsc_sol_array);
 
    // Take the solution from PETSc, and sync it to one MOOSE variable
    // We currently support one variable only but it is straightforward
    // to have multiple moose variables
    MeshBase & to_mesh = mesh().getMesh();
    auto & sync_to_var = getVariable(
        0, _sync_to_var_name, Moose::VarKindType::VAR_ANY, Moose::VarFieldType::VAR_FIELD_STANDARD);
 
    for (j = ys; j < ys + ym; j++)
      for (i = xs; i < xs + xm; i++)
      {
        Node * to_node = to_mesh.node_ptr(i + j * Mx);
        if (to_node->n_comp(sync_to_var.sys().number(), sync_to_var.number()) > 1)
          mooseError("Does not support multiple components");
 
        dof_id_type dof = to_node->dof_number(sync_to_var.sys().number(), sync_to_var.number(), 0);
        // Copy the solution to the right location
        sync_to_var.sys().solution().set(dof, _petsc_sol_array[j][i]);
      }
 
    sync_to_var.sys().solution().close();
 
    DMDAVecRestoreArray(da, _petsc_sol, &_petsc_sol_array);
  }
  else if (direction == Direction::TO_EXTERNAL_APP)
  {
    _console << "syncSolutions to external petsc App " << std::endl;
    // We could the similar thing to sync the solution back to PETSc.
  }
#endif
}

Member Data Documentation

_petsc_app

ExternalPetscSolverApp& ExternalPETScProblem::_petsc_app

private

Definition at line 43 of file ExternalPETScProblem.h.

_petsc_sol

Vec ExternalPETScProblem::_petsc_sol

private

PETSc solver solution.

Definition at line 49 of file ExternalPETScProblem.h.

Referenced by ExternalPETScProblem(), externalSolve(), syncSolutions(), and ~ExternalPETScProblem().

_sync_to_var_name

const VariableName& ExternalPETScProblem::_sync_to_var_name

private

The name of the variable to transfer to.

Definition at line 42 of file ExternalPETScProblem.h.

Referenced by syncSolutions().

_ts

TS& ExternalPETScProblem::_ts

private

PETSc solver.

Definition at line 47 of file ExternalPETScProblem.h.

Referenced by ExternalPETScProblem(), externalSolve(), and syncSolutions().

---

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

• external_petsc_solver/include/problem/ExternalPETScProblem.h
• external_petsc_solver/src/problem/ExternalPETScProblem.C