DataTransferKit - Multiphysics Solution Transfer Services  2.0
Public Types | Static Public Member Functions | List of all members
DataTransferKit::NonlinearProblemTraits< NonlinearProblem > Class Template Reference

Traits class for nonlinear problems. More...

#include <DTK_NonlinearProblemTraits.hpp>

Public Types

typedef NonlinearProblem nonlinear_problem_type
 Typedef for NonlinearProblem. More...
 
typedef NonlinearProblem::md_array_type MDArray
 Typedef for multidimensional array type. More...
 
typedef MDArray::scalar_type Scalar
 Typedef for multidimensional array scalar type. More...
 

Static Public Member Functions

static void updateState (NonlinearProblem &problem, const MDArray &u)
 Update the state of the nonlinear problem given a new solution vector. More...
 
static void evaluateResidual (const NonlinearProblem &problem, const MDArray &u, MDArray &F)
 
static void evaluateJacobian (const NonlinearProblem &problem, const MDArray &u, MDArray &J)
 

Detailed Description

template<typename NonlinearProblem>
class DataTransferKit::NonlinearProblemTraits< NonlinearProblem >

Traits class for nonlinear problems.

Definition at line 68 of file DTK_NonlinearProblemTraits.hpp.

Member Typedef Documentation

template<typename NonlinearProblem >
typedef NonlinearProblem DataTransferKit::NonlinearProblemTraits< NonlinearProblem >::nonlinear_problem_type

Typedef for NonlinearProblem.

Definition at line 72 of file DTK_NonlinearProblemTraits.hpp.

template<typename NonlinearProblem >
typedef NonlinearProblem::md_array_type DataTransferKit::NonlinearProblemTraits< NonlinearProblem >::MDArray

Typedef for multidimensional array type.

Definition at line 75 of file DTK_NonlinearProblemTraits.hpp.

template<typename NonlinearProblem >
typedef MDArray::scalar_type DataTransferKit::NonlinearProblemTraits< NonlinearProblem >::Scalar

Typedef for multidimensional array scalar type.

Definition at line 78 of file DTK_NonlinearProblemTraits.hpp.

Member Function Documentation

template<typename NonlinearProblem >
static void DataTransferKit::NonlinearProblemTraits< NonlinearProblem >::updateState ( NonlinearProblem &  problem,
const MDArray u 
)
inlinestatic

Update the state of the nonlinear problem given a new solution vector.

Definition at line 81 of file DTK_NonlinearProblemTraits.hpp.

template<typename NonlinearProblem >
static void DataTransferKit::NonlinearProblemTraits< NonlinearProblem >::evaluateResidual ( const NonlinearProblem &  problem,
const MDArray u,
MDArray F 
)
inlinestatic

Compute the nonlinear residual given a new solution vector. F must be allocated.

Definition at line 89 of file DTK_NonlinearProblemTraits.hpp.

template<typename NonlinearProblem >
static void DataTransferKit::NonlinearProblemTraits< NonlinearProblem >::evaluateJacobian ( const NonlinearProblem &  problem,
const MDArray u,
MDArray J 
)
inlinestatic

Compute the Jacobian matrix given a new solution vector. J must be allocated.

Definition at line 97 of file DTK_NonlinearProblemTraits.hpp.


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