Detailed Description

Forcing object class for xMHD.

Used to apply arbitrary external fields or dirichlet boundary conditions during time advance. If passed during a run the driver is called to modify the time centered source vector and/or the initial field for the NL solve.

Note: If dirichlet boundary conditions are being used both the source vector and initial field should be modified consistently. Otherwise these terms will unnecessarily load the linear solver.

Public Member Functions
procedure(xmhd_driver_apply), deferred	apply xmhd_driver_apply
	Modify vectors to apply forcing.

procedure	rst_load (self, rst_file)
	Setup driver from restart file.

procedure	rst_save (self, rst_file)
	Save driver info to restart file.

Member Function/Subroutine Documentation

◆ apply()

procedure(xmhd_driver_apply), deferred apply

pure virtual

Modify vectors to apply forcing.

◆ rst_load()

procedure rst_load	(	class(oft_xmhd_driver), intent(inout)	self,
		character(*), intent(in)	rst_file
	)

Setup driver from restart file.

Parameters

[in,out]	self	Forcing object
[in]	rst_file	Name of restart file

◆ rst_save()

procedure rst_save	(	class(oft_xmhd_driver), intent(inout)	self,
		character(*), intent(in)	rst_file
	)

Save driver info to restart file.