OFELI's Logo

An Object Oriented Finite Element Library

MyNLAS Class Referenceabstract

Abstract class to define by user specified function. More...

#include <MyNLAS.h>

Public Member Functions

 MyNLAS ()
 Default Constructor.
 
 MyNLAS (const Mesh &mesh)
 Constructor using mesh instance. More...
 
virtual ~MyNLAS ()
 Destructor.
 
virtual real_t Function (const Vect< real_t > &x, int i=1)=0
 Virtual member function to define nonlinear function to zeroe. More...
 
virtual real_t Gradient (const Vect< real_t > &x, int i=1, int j=1)
 Virtual member function to define partial derivatives of function. More...
 

Detailed Description

Abstract class to define by user specified function.

The user has to implement a class that inherits from the present one where the virtual functions are implemented.

Author
Rachid Touzani

Constructor & Destructor Documentation

◆ MyNLAS()

MyNLAS ( const Mesh mesh)

Constructor using mesh instance.

Parameters
meshReference to Mesh instance

Member Function Documentation

◆ Function()

virtual real_t Function ( const Vect< real_t > &  x,
int  i = 1 
)
pure virtual

Virtual member function to define nonlinear function to zeroe.

Parameters
[in]xVector of variables
[in]icomponent of function to define [Default: 1].
Returns
Value of function
Warning
The component must not be larger than vector size

◆ Gradient()

virtual real_t Gradient ( const Vect< real_t > &  x,
int  i = 1,
int  j = 1 
)
virtual

Virtual member function to define partial derivatives of function.

Parameters
[in]xVector of variables
[in]iFunction component [Default: 1]
[in]jIndex of partial derivative [Default: 1]
Returns
Value of partial derivative





Copyright © 1998-2022 Rachid Touzani