iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase > Class Template Reference

IgANet. More...

#include </home/runner/work/iganet/iganet/include/iganet.hpp>

Inheritance diagram for iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >:

Public Types
using	Base = IgABase< GeometryMap, Variable >
	Base type.
using	optimizer_options_type = typename optimizer_options_type< Optimizer >::type
	Type of the optimizer options.
using	optimizer_type = Optimizer
	Type of the optimizer.

Public Member Functions
	IgANet (IgANetOptions defaults={}, iganet::Options< typename Base::value_type > options=iganet::Options< typename Base::value_type >{})
	Default constructor.

Protected Attributes
IgANetGenerator< typename Base::value_type >	net_
	IgANet generator.
std::unique_ptr< optimizer_type >	opt_
	Optimizer.
IgANetOptions	options_
	Options.

Additional Inherited Members
Private Member Functions inherited from iganet::utils::FullQualifiedName
virtual const std::string &	name () const noexcept
	Returns the full qualified name of the object.
Private Attributes inherited from iganet::utils::FullQualifiedName
at::optional< std::string >	name_
	String storing the full qualified name of the object.

Detailed Description

template<typename Optimizer, typename GeometryMap, typename Variable, template< typename, typename > typename IgABase = ::iganet::IgABase>
requires OptimizerType<Optimizer> && FunctionSpaceType<GeometryMap> && FunctionSpaceType<Variable>
class iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >

IgANet.

This class implements the core functionality of IgANets

Member Typedef Documentation

Base

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

using iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::Base = IgABase<GeometryMap, Variable>

Base type.

optimizer_options_type

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

using iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::optimizer_options_type = typename optimizer_options_type<Optimizer>::type

Type of the optimizer options.

optimizer_type

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

using iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::optimizer_type = Optimizer

Type of the optimizer.

Constructor & Destructor Documentation

IgANet() [1/5]

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::IgANet ( IgANetOptions  defaults = {}, iganet::Options< typename Base::value_type >  options = iganet::Options<typename Base::value_type>{}  )

inlineexplicit

Default constructor.

IgANet() [2/5]

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

template<std::size_t Coeffs>

iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::IgANet ( const std::vector< int64_t > &  layers, const std::vector< std::vector< std::any > > &  activations, std::array< int64_t, Coeffs >  ncoeffs, IgANetOptions  defaults = {}, iganet::Options< typename Base::value_type >  options = iganet::Options<typename Base::value_type>{}  )

inline

Constructor: number of layers, activation functions, and number of spline coefficients (same for geometry map and variables)

IgANet() [3/5]

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

template<std::size_t... Coeffs>

iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::IgANet ( const std::vector< int64_t > &  layers, const std::vector< std::vector< std::any > > &  activations, std::tuple< std::array< int64_t, Coeffs >... >  ncoeffs, IgANetOptions  defaults = {}, iganet::Options< typename Base::value_type >  options = iganet::Options<typename Base::value_type>{}  )

inline

Constructor: number of layers, activation functions, and number of spline coefficients (same for geometry map and variables)

IgANet() [4/5]

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

template<std::size_t GeometryMapNumCoeffs, std::size_t VariableNumCoeffs>

iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::IgANet ( const std::vector< int64_t > &  layers, const std::vector< std::vector< std::any > > &  activations, std::array< int64_t, GeometryMapNumCoeffs >  geometryMapNumCoeffs, std::array< int64_t, VariableNumCoeffs >  variableNumCoeffs, IgANetOptions  defaults = {}, iganet::Options< typename Base::value_type >  options = iganet::Options<typename Base::value_type>{}  )

inline

Constructor: number of layers, activation functions, and number of spline coefficients (different for geometry map and variables)

IgANet() [5/5]

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

template<std::size_t... GeometryMapNumCoeffs, std::size_t... VariableNumCoeffs>

iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::IgANet ( const std::vector< int64_t > &  layers, const std::vector< std::vector< std::any > > &  activations, std::tuple< std::array< int64_t, GeometryMapNumCoeffs >... >  geometryMapNumCoeffs, std::tuple< std::array< int64_t, VariableNumCoeffs >... >  variableNumCoeffs, IgANetOptions  defaults = {}, iganet::Options< typename Base::value_type >  options = iganet::Options<typename Base::value_type>{}  )

inline

Constructor: number of layers, activation functions, and number of spline coefficients (different for geometry map and variables)

Member Function Documentation

epoch()

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

virtual bool iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::epoch ( int64_t  )

pure virtual

Initializes epoch.

eval()

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

void iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::eval ( )

inline

Evaluate IgANet.

inputs()

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

virtual torch::Tensor iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::inputs ( int64_t  epoch ) const

inlinevirtual

Returns the network inputs.

In the default implementation the inputs are the controll points of the geometry and the reference spline objects. This behavior can be changed by overriding this virtual function in a derived class.

load()

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

void iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::load ( const std::string &  filename, const std::string &  key = "iganet"  )

inline

Loads the IgANet from file.

loss()

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

virtual torch::Tensor iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::loss ( const torch::Tensor &  , int64_t    )

pure virtual

Computes the loss function.

named_parameters()

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

torch::OrderedDict< std::string, torch::Tensor > iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::named_parameters ( ) const

inlinenoexcept

Returns a constant reference to the named parameters of the IgANet object.

net() [1/2]

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

IgANetGenerator< typename Base::value_type > & iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::net ( )

inline

Returns a non-constant reference to the IgANet generator.

net() [2/2]

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

const IgANetGenerator< typename Base::value_type > & iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::net ( ) const

inline

Returns a constant reference to the IgANet generator.

nparameters()

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

std::size_t iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::nparameters ( ) const

inlinenoexcept

Returns the total number of parameters of the IgANet object.

operator!=()

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

bool iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::operator!= ( const IgANet< Optimizer, GeometryMap, Variable, IgABase > &  other ) const

inline

Returns true if both IgANet objects are different.

operator==()

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

bool iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::operator== ( const IgANet< Optimizer, GeometryMap, Variable, IgABase > &  other ) const

inline

Returns true if both IgANet objects are the same.

optimizer() [1/2]

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

optimizer_type & iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::optimizer ( )

inline

Returns a non-constant reference to the optimizer.

optimizer() [2/2]

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

const optimizer_type & iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::optimizer ( ) const

inline

Returns a constant reference to the optimizer.

optimizerOptions() [1/2]

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

optimizer_options_type & iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::optimizerOptions ( std::size_t  param_group = 0 )

inline

Returns a non-constant reference to the optimizer options.

optimizerOptions() [2/2]

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

const optimizer_options_type & iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::optimizerOptions ( std::size_t  param_group = 0 ) const

inline

Returns a constant reference to the optimizer options.

optimizerOptionsReset() [1/4]

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

void iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::optimizerOptionsReset ( const optimizer_options_type &  options )

inline

Resets the optimizer options.

optimizerOptionsReset() [2/4]

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

void iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::optimizerOptionsReset ( const optimizer_options_type &  options, std::size_t  param_group  )

inline

Resets the optimizer options.

optimizerOptionsReset() [3/4]

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

void iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::optimizerOptionsReset ( optimizer_options_type &&  options )

inline

Resets the optimizer options.

optimizerOptionsReset() [4/4]

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

void iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::optimizerOptionsReset ( optimizer_options_type &&  options, std::size_t  param_group  )

inline

Resets the optimizer options.

optimizerReset() [1/2]

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

void iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::optimizerReset ( bool  resetOptions = true )

inline

Resets the optimizer.

Parameters

[in]

resetOptions

Flag to indicate whether the optimizer options should be resetted

optimizerReset() [2/2]

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

void iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::optimizerReset ( const optimizer_options_type &  optimizerOptions )

inline

Resets the optimizer.

options() [1/2]

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

auto & iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::options ( )

inline

Returns a non-constant reference to the options structure.

options() [2/2]

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

const auto & iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::options ( ) const

inline

Returns a constant reference to the options structure.

parameters()

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

std::vector< torch::Tensor > iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::parameters ( ) const

inlinenoexcept

Returns a constant reference to the parameters of the IgANet object.

pretty_print()

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

virtual void iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::pretty_print ( std::ostream &  os = Log(log::info) ) const

inlineoverridevirtualnoexcept

Returns a string representation of the IgANet object.

Implements iganet::utils::Serializable.

read()

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

torch::serialize::InputArchive & iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::read ( torch::serialize::InputArchive &  archive, const std::string &  key = "iganet"  )

inline

Loads the IgANet from a torch::serialize::InputArchive object.

save()

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

void iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::save ( const std::string &  filename, const std::string &  key = "iganet"  ) const

inline

Saves the IgANet to file.

to_json()

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

virtual nlohmann::json iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::to_json ( ) const

inlineoverridevirtual

Returns the IgANet object as JSON object.

Implements iganet::utils::Serializable.

train() [1/2]

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

virtual void iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::train ( )

inlinevirtual

Trains the IgANet.

train() [2/2]

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

template<typename DataLoader >

void iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::train ( DataLoader &  loader )

inline

Trains the IgANet.

write()

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

torch::serialize::OutputArchive & iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::write ( torch::serialize::OutputArchive &  archive, const std::string &  key = "iganet"  ) const

inline

Writes the IgANet into a torch::serialize::OutputArchive object.

Member Data Documentation

net_

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

IgANetGenerator<typename Base::value_type> iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::net_

protected

IgANet generator.

opt_

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

std::unique_ptr<optimizer_type> iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::opt_

protected

Optimizer.

options_

template<typename Optimizer , typename GeometryMap , typename Variable , template< typename, typename > typename IgABase = ::iganet::IgABase>

IgANetOptions iganet::IgANet< Optimizer, GeometryMap, Variable, IgABase >::options_

protected

Options.

---

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

• include/iganet.hpp