UserTensorBase< T > Class Template Reference

#include <UserTensorBase.h>

Inheritance diagram for UserTensorBase< T >:

Public Member Functions
	UserTensorBase (const OptionSet &options)
void	setup () override
	Setup this object.
Public Member Functions inherited from NEML2Object
	NEML2Object ()=delete
	NEML2Object (NEML2Object &&)=delete
	NEML2Object (const NEML2Object &)=delete
NEML2Object &	operator= (NEML2Object &&)=delete
NEML2Object &	operator= (const NEML2Object &)=delete
virtual	~NEML2Object ()=default
	NEML2Object (const OptionSet &options)
	Construct a new NEML2Object object.
const OptionSet &	input_options () const
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.
Factory *	factory () const
	Get the factory that created this object.
const Settings &	settings () const
	Settings.
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.
template<typename T >
const T &	resolve_tensor (const std::string &name)
	Resolve a TensorName to a Tensor.
template<class T >
std::shared_ptr< T >	get_object (const std::string &section, const std::string &name)
template<class T = Solver>
std::shared_ptr< T >	get_solver (const std::string &name)
	Get a solver from the factory.
template<class T = Data>
std::shared_ptr< T >	get_data (const std::string &name)
	Get a data from the factory.
template<class T = Model>
std::shared_ptr< T >	get_model (const std::string &name)
	Get a model from the factory.
template<class T = Driver>
std::shared_ptr< T >	get_driver (const std::string &name)
	Get a driver from the factory.
template<class T = WorkScheduler>
std::shared_ptr< T >	get_scheduler (const std::string &name)
	Get a scheduler from the factory.

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

Protected Member Functions
virtual T	make () const =0
	Create the tensor given input options.

Static Protected Member Functions
static std::string	tensor_type ()
	A human-readable description of the tensor type.

Constructor & Destructor Documentation

UserTensorBase()

template<class T >

UserTensorBase

(

const OptionSet &

options

)

Member Function Documentation

expected_options()

template<class T >

OptionSet expected_options ( )

static

make()

template<class T >

virtual T make ( ) const

protectedpure virtual

Create the tensor given input options.

Implemented in FillR2, FillRot, FillSR2, FillWR2, FromTorchScript< T >, FullTensorTmpl< T >, IdentityTensor, LinspaceTensorTmpl< T >, LogspaceTensorTmpl< T >, Orientation, RandomTensorImpl< T >, RandomTensorImpl< T >, RandomTensorImpl< T >, SymmetryFromOrbifold, and UserTensorTmpl< T >.

setup()

template<class T >

void setup ( )

overridevirtual

Setup this object.

This method is called automatically if you use the Factory method get_object or get_object, right after construction. This serves as the entry point for things that are not convenient/possible to do at construction time, but are necessary before this object can be used (by others).

Reimplemented from NEML2Object.

tensor_type()

template<class T >

std::string tensor_type ( )

staticprotected

A human-readable description of the tensor type.