libMesh::DifferentiablePhysics Class Reference

This class provides a specific system class. More...

#include <diff_physics.h>

Inheritance diagram for libMesh::DifferentiablePhysics:

Public Member Functions
	DifferentiablePhysics ()
	Constructor. More...
virtual	~DifferentiablePhysics ()
	Destructor. More...
virtual std::unique_ptr< DifferentiablePhysics >	clone_physics ()=0
	Copy of this object. More...
virtual void	clear_physics ()
	Clear any data structures associated with the physics. More...
virtual void	init_physics (const System &sys)
	Initialize any data structures associated with the physics. More...
virtual bool	element_time_derivative (bool request_jacobian, DiffContext &)
	Adds the time derivative contribution on elem to elem_residual. More...
virtual bool	element_constraint (bool request_jacobian, DiffContext &)
	Adds the constraint contribution on elem to elem_residual. More...
virtual bool	side_time_derivative (bool request_jacobian, DiffContext &)
	Adds the time derivative contribution on side of elem to elem_residual. More...
virtual bool	side_constraint (bool request_jacobian, DiffContext &)
	Adds the constraint contribution on side of elem to elem_residual. More...
virtual bool	nonlocal_time_derivative (bool request_jacobian, DiffContext &)
	Adds any nonlocal time derivative contributions (e.g. More...
virtual bool	nonlocal_constraint (bool request_jacobian, DiffContext &)
	Adds any nonlocal constraint contributions (e.g. More...
virtual void	time_evolving (unsigned int var, unsigned int order)
	Tells the DiffSystem that variable var is evolving with respect to time. More...
bool	is_time_evolving (unsigned int var) const
virtual bool	eulerian_residual (bool request_jacobian, DiffContext &)
	Adds a pseudo-convection contribution on elem to elem_residual, if the nodes of elem are being translated by a moving mesh. More...
virtual bool	mass_residual (bool request_jacobian, DiffContext &)
	Subtracts a mass vector contribution on elem from elem_residual. More...
virtual bool	side_mass_residual (bool request_jacobian, DiffContext &)
	Subtracts a mass vector contribution on side of elem from elem_residual. More...
virtual bool	nonlocal_mass_residual (bool request_jacobian, DiffContext &c)
	Subtracts any nonlocal mass vector contributions (e.g. More...
virtual bool	damping_residual (bool request_jacobian, DiffContext &)
	Subtracts a damping vector contribution on elem from elem_residual. More...
virtual bool	side_damping_residual (bool request_jacobian, DiffContext &)
	Subtracts a damping vector contribution on side of elem from elem_residual. More...
virtual bool	nonlocal_damping_residual (bool request_jacobian, DiffContext &)
	Subtracts any nonlocal damping vector contributions (e.g. More...
virtual void	init_context (DiffContext &)
virtual void	set_mesh_system (System *sys)
	Tells the DifferentiablePhysics that system sys contains the isoparametric Lagrangian variables which correspond to the coordinates of mesh nodes, in problems where the mesh itself is expected to move in time. More...
const System *	get_mesh_system () const
System *	get_mesh_system ()
virtual void	set_mesh_x_var (unsigned int var)
	Tells the DifferentiablePhysics that variable var from the mesh system should be used to update the x coordinate of mesh nodes, in problems where the mesh itself is expected to move in time. More...
unsigned int	get_mesh_x_var () const
virtual void	set_mesh_y_var (unsigned int var)
	Tells the DifferentiablePhysics that variable var from the mesh system should be used to update the y coordinate of mesh nodes. More...
unsigned int	get_mesh_y_var () const
virtual void	set_mesh_z_var (unsigned int var)
	Tells the DifferentiablePhysics that variable var from the mesh system should be used to update the z coordinate of mesh nodes. More...
unsigned int	get_mesh_z_var () const
bool	_eulerian_time_deriv (bool request_jacobian, DiffContext &)
	This method simply combines element_time_derivative() and eulerian_residual(), which makes its address useful as a pointer-to-member-function when refactoring. More...
bool	have_first_order_vars () const
const std::set< unsigned int > &	get_first_order_vars () const
bool	is_first_order_var (unsigned int var) const
bool	have_second_order_vars () const
const std::set< unsigned int > &	get_second_order_vars () const
bool	is_second_order_var (unsigned int var) const

Public Attributes
bool	compute_internal_sides
	compute_internal_sides is false by default, indicating that side_* computations will only be done on boundary sides. More...

Protected Attributes
System *	_mesh_sys
	System from which to acquire moving mesh information. More...
unsigned int	_mesh_x_var
	Variables from which to acquire moving mesh information. More...
unsigned int	_mesh_y_var
unsigned int	_mesh_z_var
std::vector< unsigned int >	_time_evolving
	Stores unsigned int to tell us which variables are evolving as first order in time (1), second order in time (2), or are not time evolving (0). More...
std::set< unsigned int >	_first_order_vars
	Variable indices for those variables that are first order in time. More...
std::set< unsigned int >	_second_order_vars
	Variable indices for those variables that are second order in time. More...
std::map< unsigned int, unsigned int >	_second_order_dot_vars
	If the user adds any second order variables, then we need to also cache the map to their corresponding dot variable that will be added by this TimeSolver class. More...

Detailed Description

This class provides a specific system class.

It aims to generalize any system, linear or nonlinear, which provides both a residual and a Jacobian. For first order (in time) systems, the (nonlinear) residual computed at each time step is

\[ F(u) + G(u) - M(u,\dot{u})\dot{u} = 0 \]

for unsteady TimeSolver and \( F(u) = 0\) for steady TimeSolver. \(F(u)\) is computed by element/side_time_derivative, \( G(u) \) is computed using element/side_constraint, and \( M(u,\dot{u})\dot{u} \) is computed using the mass_residual methods.

For second order (in time) systems, the (nonlinear) residual computed at each time step is

\[ M(u,\ddot{u})\ddot{u} + C(u,\dot{u})\dot{u} + F(u) + G(u) = 0 \]

for unsteady TimeSolver and \( F(u) = 0\) for steady TimeSolver. \(F(u)\) is computed by element/side_time_derivative, \(G(u)\) is computed using element/side_constraint, \(C(u,\dot{u})\dot{u}\) is computed using the damping_residual methods and \( -M(u,\ddot{u})\ddot{u}\) is computed using the mass_residual methods. This is the sign convention used by the default implementation; if the method is overridden, the user can choose any self-consistent sign convention they wish.

FEMContext provides methods for querying values of the solution \({u}\), its "rate" \(\dot{u}\) and its "acceleration" \(\ddot{u}\). Furthermore, derivatives of each of these w.r.t the nonlinear iteration unknown (e.g. in EulerSolver, the solution at the next time step \( u_{n+1} \)) are provided through DiffContext::get_elem_solution_derivative(), DiffContext::get_elem_solution_rate_derivative(), and DiffContext::get_elem_solution_accel_derivative(). The should be incorporated into the Jacobian evaluations, if the Jacobian is being provided.

Author

Roy H. Stogner

Date

2006

Definition at line 76 of file diff_physics.h.

Constructor & Destructor Documentation

DifferentiablePhysics()

libMesh::DifferentiablePhysics::DifferentiablePhysics ( )

inline

Constructor.

Optionally initializes required data structures.

Definition at line 84 of file diff_physics.h.

                           :
    compute_internal_sides (false),
    _mesh_sys              (nullptr),
    _mesh_x_var            (libMesh::invalid_uint),
    _mesh_y_var            (libMesh::invalid_uint),
    _mesh_z_var            (libMesh::invalid_uint)
  {}

~DifferentiablePhysics()

libMesh::DifferentiablePhysics::~DifferentiablePhysics ( )

virtualdefault

Destructor.

Member Function Documentation

_eulerian_time_deriv()

bool libMesh::DifferentiablePhysics::_eulerian_time_deriv	(	bool	request_jacobian,
		DiffContext &	context
	)

This method simply combines element_time_derivative() and eulerian_residual(), which makes its address useful as a pointer-to-member-function when refactoring.

Definition at line 96 of file diff_physics.C.

References element_time_derivative(), and eulerian_residual().

Referenced by libMesh::EulerSolver::element_residual(), libMesh::Euler2Solver::element_residual(), and libMesh::NewmarkSolver::element_residual().

{
  // For any problem we need time derivative terms
  request_jacobian =
    this->element_time_derivative(request_jacobian, context);

  // For a moving mesh problem we may need the pseudoconvection term too
  return this->eulerian_residual(request_jacobian, context) &&
    request_jacobian;
}

clear_physics()

void libMesh::DifferentiablePhysics::clear_physics ( )

virtual

Clear any data structures associated with the physics.

Definition at line 28 of file diff_physics.C.

References _time_evolving.

Referenced by libMesh::DifferentiableSystem::clear().

{
  _time_evolving.resize(0);
}

clone_physics()

virtual std::unique_ptr<DifferentiablePhysics> libMesh::DifferentiablePhysics::clone_physics ( )

pure virtual

Copy of this object.

User should override to copy any needed state.

Implemented in libMesh::DifferentiableSystem, and SigmaPhysics.

Referenced by libMesh::DifferentiableSystem::attach_physics(), and libMesh::DifferentiableSystem::push_physics().

damping_residual()

virtual bool libMesh::DifferentiablePhysics::damping_residual ( bool  request_jacobian, DiffContext &    )

inlinevirtual

Subtracts a damping vector contribution on elem from elem_residual.

This method is not used in first-order-in-time problems. For second-order-in-time problems, this is the \( C(u,\ddot{u})\ddot{u} \) term. This method is only called for UnsteadySolver-based TimeSolvers.

If this method receives request_jacobian = true, then it should compute elem_jacobian and return true if possible. If elem_jacobian has not been computed then the method should return false.

If the problem has no damping, the default "do-nothing" is correct. Otherwise, this must be reimplemented.

Reimplemented in SecondOrderScalarSystemFirstOrderTimeSolverBase, and SecondOrderScalarSystemSecondOrderTimeSolverBase.

Definition at line 360 of file diff_physics.h.

Referenced by libMesh::EulerSolver::element_residual(), libMesh::Euler2Solver::element_residual(), and libMesh::NewmarkSolver::element_residual().

  {
    return request_jacobian;
  }

element_constraint()

virtual bool libMesh::DifferentiablePhysics::element_constraint ( bool  request_jacobian, DiffContext &    )

inlinevirtual

Adds the constraint contribution on elem to elem_residual.

If this method receives request_jacobian = true, then it should compute elem_jacobian and return true if possible. If elem_jacobian has not been computed then the method should return false.

Users may need to reimplement this for their particular PDE.

To implement the constraint 0 = G(u), the user should examine u = elem_solution and add (G(u), phi_i) to elem_residual in elem_constraint().

Reimplemented in CoupledSystem, and NavierSystem.

Definition at line 144 of file diff_physics.h.

Referenced by libMesh::EulerSolver::element_residual(), libMesh::SteadySolver::element_residual(), libMesh::Euler2Solver::element_residual(), libMesh::NewmarkSolver::element_residual(), and libMesh::EigenTimeSolver::element_residual().

  {
    return request_jacobian;
  }

element_time_derivative()

virtual bool libMesh::DifferentiablePhysics::element_time_derivative ( bool  request_jacobian, DiffContext &    )

inlinevirtual

Adds the time derivative contribution on elem to elem_residual.

If this method receives request_jacobian = true, then it should compute elem_jacobian and return true if possible. If elem_jacobian has not been computed then the method should return false.

Users need to reimplement this for their particular PDE.

To implement the physics model du/dt = F(u), the user should examine u = elem_solution and add (F(u), phi_i) to elem_residual in elem_time_derivative().

Reimplemented in SecondOrderScalarSystemFirstOrderTimeSolverBase, FirstOrderScalarSystemBase, HeatSystem, HilbertSystem, CoupledSystem, libMesh::VariationalSmootherSystem, ElasticitySystem, ElasticitySystem, HeatSystem, LaplaceSystem, CurlCurlSystem, LaplaceSystem, PoissonSystem, LaplaceSystem, LaplaceSystem, CurlCurlSystem, SolidSystem, NavierSystem, SigmaPhysics, and HeatSystem.

Definition at line 125 of file diff_physics.h.

Referenced by _eulerian_time_deriv(), libMesh::SteadySolver::element_residual(), and libMesh::EigenTimeSolver::element_residual().

  {
    return request_jacobian;
  }

eulerian_residual()

virtual bool libMesh::DifferentiablePhysics::eulerian_residual ( bool  request_jacobian, DiffContext &    )

inlinevirtual

Adds a pseudo-convection contribution on elem to elem_residual, if the nodes of elem are being translated by a moving mesh.

The library provides a basic implementation in FEMPhysics::eulerian_residual()

Reimplemented in libMesh::FEMPhysics, and SolidSystem.

Definition at line 277 of file diff_physics.h.

Referenced by _eulerian_time_deriv().

  {
    return request_jacobian;
  }

get_first_order_vars()

const std::set<unsigned int>& libMesh::DifferentiablePhysics::get_first_order_vars ( ) const

inline

Returns

The set of first order in time variable indices. May be empty.

Definition at line 506 of file diff_physics.h.

References _first_order_vars.

Referenced by libMesh::DifferentiableSystem::have_first_order_scalar_vars().

  { return _first_order_vars; }

get_mesh_system() [1/2]

const System * libMesh::DifferentiablePhysics::get_mesh_system ( ) const

inline

Returns

A const reference to the system with variables corresponding to mesh nodal coordinates, or nullptr if the mesh is fixed. Useful for ALE calculations.

Definition at line 613 of file diff_physics.h.

References _mesh_sys.

Referenced by libMesh::FEMSystem::build_context().

{
  return _mesh_sys;
}

get_mesh_system() [2/2]

System * libMesh::DifferentiablePhysics::get_mesh_system ( )

inline

Returns

A reference to the system with variables corresponding to mesh nodal coordinates, or nullptr if the mesh is fixed.

Definition at line 619 of file diff_physics.h.

References _mesh_sys.

{
  return _mesh_sys;
}

get_mesh_x_var()

unsigned int libMesh::DifferentiablePhysics::get_mesh_x_var ( ) const

inline

Returns

The variable number corresponding to the mesh x coordinate. Useful for ALE calculations.

Definition at line 625 of file diff_physics.h.

References _mesh_x_var.

Referenced by libMesh::FEMSystem::build_context().

{
  return _mesh_x_var;
}

get_mesh_y_var()

unsigned int libMesh::DifferentiablePhysics::get_mesh_y_var ( ) const

inline

Returns

The variable number corresponding to the mesh y coordinate. Useful for ALE calculations.

Definition at line 631 of file diff_physics.h.

References _mesh_y_var.

Referenced by libMesh::FEMSystem::build_context().

{
  return _mesh_y_var;
}

get_mesh_z_var()

unsigned int libMesh::DifferentiablePhysics::get_mesh_z_var ( ) const

inline

Returns

The variable number corresponding to the mesh z coordinate. Useful for ALE calculations.

Definition at line 637 of file diff_physics.h.

References _mesh_z_var.

Referenced by libMesh::FEMSystem::build_context().

{
  return _mesh_z_var;
}

get_second_order_vars()

const std::set<unsigned int>& libMesh::DifferentiablePhysics::get_second_order_vars ( ) const

inline

Returns

The set of second order in time variable indices. May be empty.

Definition at line 519 of file diff_physics.h.

References _second_order_vars.

Referenced by libMesh::DifferentiableSystem::add_second_order_dot_vars(), libMesh::DiffContext::DiffContext(), libMesh::Euler2Solver::element_residual(), libMesh::DifferentiableSystem::have_second_order_scalar_vars(), and libMesh::FEMContext::pre_fe_reinit().

  { return _second_order_vars; }

have_first_order_vars()

bool libMesh::DifferentiablePhysics::have_first_order_vars ( ) const

inline

Definition at line 500 of file diff_physics.h.

References _first_order_vars.

Referenced by libMesh::DifferentiableSystem::have_first_order_scalar_vars().

  { return !_first_order_vars.empty(); }

have_second_order_vars()

bool libMesh::DifferentiablePhysics::have_second_order_vars ( ) const

inline

Definition at line 513 of file diff_physics.h.

References _second_order_vars.

Referenced by libMesh::EulerSolver::element_residual(), and libMesh::DifferentiableSystem::have_second_order_scalar_vars().

  { return !_second_order_vars.empty(); }

init_context()

virtual void libMesh::DifferentiablePhysics::init_context ( DiffContext &  )

inlinevirtual

Reimplemented in libMesh::FEMSystem, HeatSystem, HilbertSystem, CoupledSystem, libMesh::VariationalSmootherSystem, ElasticitySystem, ElasticitySystem, HeatSystem, LaplaceSystem, CurlCurlSystem, LaplaceSystem, PoissonSystem, LaplaceSystem, LaplaceSystem, CurlCurlSystem, SolidSystem, NavierSystem, SigmaPhysics, and HeatSystem.

Definition at line 406 of file diff_physics.h.

{}

init_physics()

void libMesh::DifferentiablePhysics::init_physics ( const System &  sys )

virtual

Initialize any data structures associated with the physics.

Definition at line 35 of file diff_physics.C.

References _time_evolving, and libMesh::System::n_vars().

Referenced by libMesh::DifferentiableSystem::init_data().

{
  // give us flags for every variable that might be time evolving
  _time_evolving.resize(sys.n_vars(), false);
}

is_first_order_var()

bool libMesh::DifferentiablePhysics::is_first_order_var ( unsigned int  var ) const

inline

Definition at line 509 of file diff_physics.h.

References _first_order_vars.

  { return _first_order_vars.find(var) != _first_order_vars.end(); }

is_second_order_var()

bool libMesh::DifferentiablePhysics::is_second_order_var ( unsigned int  var ) const

inline

Definition at line 522 of file diff_physics.h.

References _second_order_vars.

Referenced by libMesh::FirstOrderUnsteadySolver::compute_second_order_eqns().

  { return _second_order_vars.find(var) != _second_order_vars.end(); }

is_time_evolving()

bool libMesh::DifferentiablePhysics::is_time_evolving ( unsigned int  var ) const

inline

Returns

true iff variable var is evolving with respect to time. In general, the user's init() function should have set time_evolving() for any variables which behave like du/dt = F(u), and should not call time_evolving() for any variables which behave like 0 = G(u).

Definition at line 260 of file diff_physics.h.

References _time_evolving, and libMesh::libmesh_assert().

Referenced by libMesh::FEMPhysics::eulerian_residual(), libMesh::FEMSystem::init_context(), libMesh::FEMPhysics::mass_residual(), and nonlocal_mass_residual().

  {
    libmesh_assert_less(var,_time_evolving.size());
    libmesh_assert( _time_evolving[var] == 0 ||
                    _time_evolving[var] == 1 ||
                    _time_evolving[var] == 2 );
    return _time_evolving[var];
  }

mass_residual()

virtual bool libMesh::DifferentiablePhysics::mass_residual ( bool  request_jacobian, DiffContext &    )

inlinevirtual

Subtracts a mass vector contribution on elem from elem_residual.

For first-order-in-time problems, this is the \( M(u,\dot{u})\dot{u} \) term. For second-order-in-time problems, this is the \( M(u,\ddot{u})\ddot{u} \) term. This method is only called for UnsteadySolver-based TimeSolvers.

If this method receives request_jacobian = true, then it should compute elem_jacobian and return true if possible. If elem_jacobian has not been computed then the method should return false.

Many first-order-in-time problems can use the reimplementation in FEMPhysics::mass_residual which subtracts (du/dt,v) for each transient variable u; users with more complicated transient problems or second-order-in-time problems will need to reimplement this themselves.

Reimplemented in SecondOrderScalarSystemFirstOrderTimeSolverBase, SecondOrderScalarSystemSecondOrderTimeSolverBase, FirstOrderScalarSystemBase, libMesh::FEMPhysics, ElasticitySystem, ElasticitySystem, and NavierSystem.

Definition at line 302 of file diff_physics.h.

Referenced by libMesh::EulerSolver::element_residual(), libMesh::Euler2Solver::element_residual(), libMesh::NewmarkSolver::element_residual(), and libMesh::EigenTimeSolver::element_residual().

  {
    return request_jacobian;
  }

nonlocal_constraint()

virtual bool libMesh::DifferentiablePhysics::nonlocal_constraint ( bool  request_jacobian, DiffContext &    )

inlinevirtual

Adds any nonlocal constraint contributions (e.g.

some components of constraints in scalar variable equations) to elem_residual

If this method receives request_jacobian = true, then it should also modify elem_jacobian and return true if possible. If the Jacobian changes have not been computed then the method should return false.

Users may need to reimplement this for PDEs on systems to which SCALAR variables with non-transient equations have been added.

Definition at line 233 of file diff_physics.h.

Referenced by libMesh::EulerSolver::nonlocal_residual(), libMesh::SteadySolver::nonlocal_residual(), libMesh::Euler2Solver::nonlocal_residual(), libMesh::EigenTimeSolver::nonlocal_residual(), and libMesh::NewmarkSolver::nonlocal_residual().

  {
    return request_jacobian;
  }

nonlocal_damping_residual()

virtual bool libMesh::DifferentiablePhysics::nonlocal_damping_residual ( bool  request_jacobian, DiffContext &    )

inlinevirtual

Subtracts any nonlocal damping vector contributions (e.g.

any first time derivative coefficients in scalar variable equations) from elem_residual

If this method receives request_jacobian = true, then it should also modify elem_jacobian and return true if possible. If the Jacobian changes have not been computed then the method should return false.

Definition at line 394 of file diff_physics.h.

Referenced by libMesh::EulerSolver::nonlocal_residual(), libMesh::Euler2Solver::nonlocal_residual(), and libMesh::NewmarkSolver::nonlocal_residual().

  {
    return request_jacobian;
  }

nonlocal_mass_residual()

bool libMesh::DifferentiablePhysics::nonlocal_mass_residual ( bool  request_jacobian, DiffContext &  c  )

virtual

Subtracts any nonlocal mass vector contributions (e.g.

any time derivative coefficients in scalar variable equations) from elem_residual

If this method receives request_jacobian = true, then it should also modify elem_jacobian and return true if possible. If the Jacobian changes have not been computed then the method should return false.

Many problems can use the reimplementation in FEMPhysics::mass_residual which subtracts (du/dt,v) for each transient scalar variable u; users with more complicated transient scalar variable equations will need to reimplement this themselves.

Definition at line 57 of file diff_physics.C.

References libMesh::DiffContext::elem_solution_rate_derivative, libMesh::FEType::family, libMesh::DiffContext::get_dof_indices(), libMesh::DiffContext::get_elem_jacobian(), libMesh::DiffContext::get_elem_residual(), libMesh::DiffContext::get_elem_solution(), libMesh::DiffContext::get_system(), is_time_evolving(), libMesh::make_range(), libMesh::DiffContext::n_vars(), libMesh::SCALAR, libMesh::Variable::type(), and libMesh::System::variable().

Referenced by libMesh::EulerSolver::nonlocal_residual(), libMesh::Euler2Solver::nonlocal_residual(), libMesh::EigenTimeSolver::nonlocal_residual(), and libMesh::NewmarkSolver::nonlocal_residual().

{
  FEMContext & context = cast_ref<FEMContext &>(c);

  for (auto var : make_range(context.n_vars()))
    {
      if (!this->is_time_evolving(var))
        continue;

      if (c.get_system().variable(var).type().family != SCALAR)
        continue;

      const std::vector<dof_id_type> & dof_indices =
        context.get_dof_indices(var);

      const unsigned int n_dofs = cast_int<unsigned int>
        (dof_indices.size());

      DenseSubVector<Number> & Fs = context.get_elem_residual(var);
      DenseSubMatrix<Number> & Kss = context.get_elem_jacobian( var, var );

      const libMesh::DenseSubVector<libMesh::Number> & Us =
        context.get_elem_solution(var);

      for (unsigned int i=0; i != n_dofs; ++i)
        {
          Fs(i) -= Us(i);

          if (request_jacobian)
            Kss(i,i) -= context.elem_solution_rate_derivative;
        }
    }

  return request_jacobian;
}

nonlocal_time_derivative()

virtual bool libMesh::DifferentiablePhysics::nonlocal_time_derivative ( bool  request_jacobian, DiffContext &    )

inlinevirtual

Adds any nonlocal time derivative contributions (e.g.

some components of time derivatives in scalar variable equations) to elem_residual

If this method receives request_jacobian = true, then it should also modify elem_jacobian and return true if possible. If the Jacobian changes have not been computed then the method should return false.

Users may need to reimplement this for PDEs on systems to which SCALAR variables have been added.

Definition at line 214 of file diff_physics.h.

Referenced by libMesh::EulerSolver::nonlocal_residual(), libMesh::SteadySolver::nonlocal_residual(), libMesh::Euler2Solver::nonlocal_residual(), libMesh::EigenTimeSolver::nonlocal_residual(), and libMesh::NewmarkSolver::nonlocal_residual().

  {
    return request_jacobian;
  }

set_mesh_system()

void libMesh::DifferentiablePhysics::set_mesh_system ( System *  sys )

inlinevirtual

Tells the DifferentiablePhysics that system sys contains the isoparametric Lagrangian variables which correspond to the coordinates of mesh nodes, in problems where the mesh itself is expected to move in time.

The system with mesh coordinate data (which may be this system itself, for fully coupled moving mesh problems) is currently assumed to have new (end of time step) mesh coordinates stored in solution, old (beginning of time step) mesh coordinates stored in _old_nonlinear_solution, and constant velocity motion during each time step.

Activating this function ensures that local (but not neighbor!) element geometry is correctly repositioned when evaluating element residuals.

Currently sys must be *this for a tightly coupled moving mesh problem or nullptr to stop mesh movement; loosely coupled moving mesh problems are not implemented.

This code is experimental. "Trust but verify, and not in that order"

Definition at line 569 of file diff_physics.h.

References _mesh_sys.

Referenced by SolidSystem::init_data().

{
  // For now we assume that we're doing fully coupled mesh motion
  //  if (sys && sys != this)
  //    libmesh_not_implemented();

  // For the foreseeable future we'll assume that we keep these
  // Systems in the same EquationSystems
  // libmesh_assert_equal_to (&this->get_equation_systems(),
  //                          &sys->get_equation_systems());

  // And for the immediate future this code may not even work
  libmesh_experimental();

  _mesh_sys = sys;
}

set_mesh_x_var()

void libMesh::DifferentiablePhysics::set_mesh_x_var ( unsigned int  var )

inlinevirtual

Tells the DifferentiablePhysics that variable var from the mesh system should be used to update the x coordinate of mesh nodes, in problems where the mesh itself is expected to move in time.

The system with mesh coordinate data (which may be this system itself, for fully coupled moving mesh problems) is currently assumed to have new (end of time step) mesh coordinates stored in solution, old (beginning of time step) mesh coordinates stored in _old_nonlinear_solution, and constant velocity motion during each time step.

Activating this function ensures that local (but not neighbor!) element geometry is correctly repositioned when evaluating element residuals.

Definition at line 589 of file diff_physics.h.

References _mesh_x_var.

Referenced by SolidSystem::init_data().

{
  _mesh_x_var = var;
}

set_mesh_y_var()

void libMesh::DifferentiablePhysics::set_mesh_y_var ( unsigned int  var )

inlinevirtual

Tells the DifferentiablePhysics that variable var from the mesh system should be used to update the y coordinate of mesh nodes.

Definition at line 597 of file diff_physics.h.

References _mesh_y_var.

Referenced by SolidSystem::init_data().

{
  _mesh_y_var = var;
}

set_mesh_z_var()

void libMesh::DifferentiablePhysics::set_mesh_z_var ( unsigned int  var )

inlinevirtual

Tells the DifferentiablePhysics that variable var from the mesh system should be used to update the z coordinate of mesh nodes.

Definition at line 605 of file diff_physics.h.

References _mesh_z_var.

Referenced by SolidSystem::init_data().

{
  _mesh_z_var = var;
}

side_constraint()

virtual bool libMesh::DifferentiablePhysics::side_constraint ( bool  request_jacobian, DiffContext &    )

inlinevirtual

Adds the constraint contribution on side of elem to elem_residual.

If this method receives request_jacobian = true, then it should compute elem_jacobian and return true if possible. If elem_jacobian has not been computed then the method should return false.

Users may need to reimplement this for their particular PDE depending on the boundary conditions.

To implement a weak form of the constraint 0 = G(u), the user should examine u = elem_solution and add (G(u), phi_i) boundary integral contributions to elem_residual in side_constraint().

Reimplemented in LaplaceSystem, LaplaceSystem, LaplaceSystem, and NavierSystem.

Definition at line 195 of file diff_physics.h.

Referenced by libMesh::EulerSolver::side_residual(), libMesh::SteadySolver::side_residual(), libMesh::Euler2Solver::side_residual(), libMesh::EigenTimeSolver::side_residual(), and libMesh::NewmarkSolver::side_residual().

  {
    return request_jacobian;
  }

side_damping_residual()

virtual bool libMesh::DifferentiablePhysics::side_damping_residual ( bool  request_jacobian, DiffContext &    )

inlinevirtual

Subtracts a damping vector contribution on side of elem from elem_residual.

If this method receives request_jacobian = true, then it should compute elem_jacobian and return true if possible. If elem_jacobian has not been computed then the method should return false.

For most problems, the default implementation of "do nothing" is correct; users with boundary conditions including first time derivatives may need to reimplement this themselves.

Definition at line 378 of file diff_physics.h.

Referenced by libMesh::EulerSolver::side_residual(), libMesh::Euler2Solver::side_residual(), and libMesh::NewmarkSolver::side_residual().

  {
    return request_jacobian;
  }

side_mass_residual()

virtual bool libMesh::DifferentiablePhysics::side_mass_residual ( bool  request_jacobian, DiffContext &    )

inlinevirtual

Subtracts a mass vector contribution on side of elem from elem_residual.

If this method receives request_jacobian = true, then it should compute elem_jacobian and return true if possible. If elem_jacobian has not been computed then the method should return false.

For most problems, the default implementation of "do nothing" is correct; users with boundary conditions including time derivatives may need to reimplement this themselves.

Definition at line 320 of file diff_physics.h.

Referenced by libMesh::EulerSolver::side_residual(), libMesh::Euler2Solver::side_residual(), libMesh::EigenTimeSolver::side_residual(), and libMesh::NewmarkSolver::side_residual().

  {
    return request_jacobian;
  }

side_time_derivative()

virtual bool libMesh::DifferentiablePhysics::side_time_derivative ( bool  request_jacobian, DiffContext &    )

inlinevirtual

Adds the time derivative contribution on side of elem to elem_residual.

If this method receives request_jacobian = true, then it should compute elem_jacobian and return true if possible. If elem_jacobian has not been computed then the method should return false.

Users may need to reimplement this for their particular PDE depending on the boundary conditions.

To implement a weak form of the source term du/dt = F(u) on sides, such as might arise in a flux boundary condition, the user should examine u = elem_solution and add (F(u), phi_i) boundary integral contributions to elem_residual in side_constraint().

Reimplemented in ElasticitySystem, ElasticitySystem, CurlCurlSystem, CurlCurlSystem, and SolidSystem.

Definition at line 174 of file diff_physics.h.

Referenced by libMesh::EulerSolver::side_residual(), libMesh::SteadySolver::side_residual(), libMesh::Euler2Solver::side_residual(), libMesh::EigenTimeSolver::side_residual(), and libMesh::NewmarkSolver::side_residual().

  {
    return request_jacobian;
  }

time_evolving()

void libMesh::DifferentiablePhysics::time_evolving ( unsigned int  var, unsigned int  order  )

virtual

Tells the DiffSystem that variable var is evolving with respect to time.

In general, the user's init() function should call time_evolving() with order 1 for any variables which behave like du/dt = F(u), with order 2 for any variables that behave like d^2u/dt^2 = F(u), and should not call time_evolving() for any variables which behave like 0 = G(u).

Most derived systems will not have to reimplement this function; however any system which reimplements mass_residual() may have to reimplement time_evolving() to prepare data structures.

Definition at line 41 of file diff_physics.C.

References _first_order_vars, _second_order_vars, and _time_evolving.

Referenced by libMesh::DifferentiableSystem::add_second_order_dot_vars(), SigmaPhysics::init_data(), CurlCurlSystem::init_data(), and HeatSystem::init_data().

{
  libmesh_error_msg_if(order != 1 && order != 2, "Input order must be 1 or 2!");

  if (_time_evolving.size() <= var)
    _time_evolving.resize(var+1, 0);

  _time_evolving[var] = order;

  if (order == 1)
    _first_order_vars.insert(var);
  else
    _second_order_vars.insert(var);
}

Member Data Documentation

_first_order_vars

std::set<unsigned int> libMesh::DifferentiablePhysics::_first_order_vars

protected

Variable indices for those variables that are first order in time.

Definition at line 548 of file diff_physics.h.

Referenced by get_first_order_vars(), have_first_order_vars(), is_first_order_var(), and time_evolving().

_mesh_sys

System* libMesh::DifferentiablePhysics::_mesh_sys

protected

System from which to acquire moving mesh information.

Definition at line 531 of file diff_physics.h.

Referenced by libMesh::FEMPhysics::eulerian_residual(), get_mesh_system(), libMesh::FEMSystem::mesh_position_get(), libMesh::FEMSystem::mesh_position_set(), libMesh::FEMSystem::numerical_jacobian(), and set_mesh_system().

_mesh_x_var

unsigned int libMesh::DifferentiablePhysics::_mesh_x_var

protected

Variables from which to acquire moving mesh information.

Definition at line 536 of file diff_physics.h.

Referenced by libMesh::FEMPhysics::eulerian_residual(), get_mesh_x_var(), libMesh::FEMSystem::mesh_position_get(), libMesh::FEMSystem::numerical_jacobian(), and set_mesh_x_var().

_mesh_y_var

unsigned int libMesh::DifferentiablePhysics::_mesh_y_var

protected

Definition at line 536 of file diff_physics.h.

Referenced by libMesh::FEMPhysics::eulerian_residual(), get_mesh_y_var(), libMesh::FEMSystem::mesh_position_get(), libMesh::FEMSystem::numerical_jacobian(), and set_mesh_y_var().

_mesh_z_var

unsigned int libMesh::DifferentiablePhysics::_mesh_z_var

protected

Definition at line 536 of file diff_physics.h.

Referenced by libMesh::FEMPhysics::eulerian_residual(), get_mesh_z_var(), libMesh::FEMSystem::mesh_position_get(), libMesh::FEMSystem::numerical_jacobian(), and set_mesh_z_var().

_second_order_dot_vars

std::map<unsigned int,unsigned int> libMesh::DifferentiablePhysics::_second_order_dot_vars

protected

If the user adds any second order variables, then we need to also cache the map to their corresponding dot variable that will be added by this TimeSolver class.

Definition at line 560 of file diff_physics.h.

Referenced by libMesh::DifferentiableSystem::add_second_order_dot_vars(), and libMesh::DifferentiableSystem::get_second_order_dot_var().

_second_order_vars

std::set<unsigned int> libMesh::DifferentiablePhysics::_second_order_vars

protected

Variable indices for those variables that are second order in time.

Definition at line 553 of file diff_physics.h.

Referenced by get_second_order_vars(), have_second_order_vars(), is_second_order_var(), and time_evolving().

_time_evolving

std::vector<unsigned int> libMesh::DifferentiablePhysics::_time_evolving

protected

Stores unsigned int to tell us which variables are evolving as first order in time (1), second order in time (2), or are not time evolving (0).

Definition at line 543 of file diff_physics.h.

Referenced by clear_physics(), init_physics(), is_time_evolving(), and time_evolving().

compute_internal_sides

bool libMesh::DifferentiablePhysics::compute_internal_sides

compute_internal_sides is false by default, indicating that side_* computations will only be done on boundary sides.

If compute_internal_sides is true, computations will be done on sides between elements as well.

Definition at line 156 of file diff_physics.h.

---

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

• include/physics/diff_physics.h
• src/physics/diff_physics.C