Driver Class Reference

The Driver drives the execution of a NEML2 Model. More...

Detailed Description

The Driver drives the execution of a NEML2 Model.

#include <Driver.h>

Inheritance diagram for Driver:

Public Member Functions
	Driver (const OptionSet &options)
	Construct a new Driver object.
virtual bool	run ()=0
	Let the driver run, return true upon successful completion, and return false otherwise.
Public Member Functions inherited from NEML2Object
	NEML2Object (const OptionSet &options)
	Construct a new NEML2Object object.
virtual	~NEML2Object ()=default
const OptionSet &	input_options () const
virtual void	setup ()
	Setup this object.
const std::string &	name () const
	A readonly reference to the object's name.
const std::string &	type () const
	A readonly reference to the object's type.
const std::string &	path () const
	A readonly reference to the object's path.
const std::string &	doc () const
	A readonly reference to the object's docstring.
template<typename T = NEML2Object>
const T *	host () const
	Get a readonly pointer to the host.
template<typename T = NEML2Object>
T *	host ()
	Get a writable pointer to the host.

Static Public Member Functions
static OptionSet	expected_options ()
Static Public Member Functions inherited from NEML2Object
static OptionSet	expected_options ()

Protected Member Functions
virtual void	check_integrity () const
	Check the integrity of the set up.

Protected Attributes
bool	_verbose
	Whether to print out additional (debugging) information during the execution.

Constructor & Destructor Documentation

Driver()

Driver

(

const OptionSet &

options

)

Construct a new Driver object.

Parameters

options

The options extracted from the input file

Member Function Documentation

check_integrity()

virtual void check_integrity ( ) const

inlineprotectedvirtual

Check the integrity of the set up.

Reimplemented in LargeDeformationIncrementalSolidMechanicsDriver, SolidMechanicsDriver, and TransientDriver.

expected_options()

OptionSet expected_options ( )

static

run()

virtual bool run ( )

pure virtual

Let the driver run, return true upon successful completion, and return false otherwise.

Implemented in TransientDriver.

Member Data Documentation

_verbose

bool _verbose

protected

Whether to print out additional (debugging) information during the execution.