https://mooseframework.inl.gov
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
MeshDisplacedInterface Class Reference

Interface for objects acting when the mesh has been displaced. More...

#include <MeshDisplacedInterface.h>

Inheritance diagram for MeshDisplacedInterface:
[legend]

Public Member Functions

 MeshDisplacedInterface (const InputParameters &params)
 
virtual ~MeshDisplacedInterface ()=default
 
 MeshDisplacedInterface (const MeshDisplacedInterface &object, const Moose::Kokkos::FunctorCopy &key)
 Special constructor used for Kokkos functor copy during parallel dispatch. More...
 
virtual void meshDisplaced ()
 Called on this object when the displaced mesh gets updated. More...
 

Static Public Member Functions

static InputParameters validParams ()
 

Protected Attributes

FEProblemBase_mdi_feproblem
 Reference to FEProblemBase instance. More...
 

Detailed Description

Interface for objects acting when the mesh has been displaced.

Definition at line 21 of file MeshDisplacedInterface.h.

Constructor & Destructor Documentation

◆ MeshDisplacedInterface() [1/2]

MeshDisplacedInterface::MeshDisplacedInterface ( const InputParameters params)

Definition at line 21 of file MeshDisplacedInterface.C.

22  : _mdi_feproblem(*params.getCheckedPointerParam<FEProblemBase *>("_fe_problem_base"))
23 {
25 }
T getCheckedPointerParam(const std::string &name, const std::string &error_string="") const
Verifies that the requested parameter exists and is not NULL and returns it to the caller...
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
void notifyWhenMeshDisplaces(MeshDisplacedInterface *mdi)
Register an object that derives from MeshDisplacedInterface to be notified when the displaced mesh ge...
FEProblemBase & _mdi_feproblem
Reference to FEProblemBase instance.

◆ ~MeshDisplacedInterface()

virtual MeshDisplacedInterface::~MeshDisplacedInterface ( )
virtualdefault

◆ MeshDisplacedInterface() [2/2]

MeshDisplacedInterface::MeshDisplacedInterface ( const MeshDisplacedInterface object,
const Moose::Kokkos::FunctorCopy key 
)

Special constructor used for Kokkos functor copy during parallel dispatch.

Definition at line 28 of file MeshDisplacedInterface.C.

31 {
32 }
FEProblemBase & _mdi_feproblem
Reference to FEProblemBase instance.

Member Function Documentation

◆ meshDisplaced()

virtual void MeshDisplacedInterface::meshDisplaced ( )
inlinevirtual

Called on this object when the displaced mesh gets updated.

Definition at line 40 of file MeshDisplacedInterface.h.

40 {}

◆ validParams()

InputParameters MeshDisplacedInterface::validParams ( )
static

Definition at line 15 of file MeshDisplacedInterface.C.

16 {
18  return params;
19 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters emptyInputParameters()

Member Data Documentation

◆ _mdi_feproblem

FEProblemBase& MeshDisplacedInterface::_mdi_feproblem
protected

Reference to FEProblemBase instance.

Definition at line 44 of file MeshDisplacedInterface.h.

Referenced by MeshDisplacedInterface().


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