LifeV
MultiscaleCouplingFunction Class Reference

MultiscaleCouplingFunction - The multiscale function for the couplings. More...

#include <MultiscaleCoupling.hpp>

+ Collaboration diagram for MultiscaleCouplingFunction:

Private Attributes

const multiscaleCoupling_TypeM_coupling
 
UInt M_couplingID
 

Constructors & Destructor

 MultiscaleCouplingFunction ()
 Constructor. More...
 
 MultiscaleCouplingFunction (const multiscaleCoupling_Type *coupling, const UInt &id)
 Constructor. More...
 
virtual ~MultiscaleCouplingFunction ()
 Destructor. More...
 

Methods

Real function (const Real &t, const Real &, const Real &, const Real &, const UInt &)
 Evaluate the coupling quantity. More...
 

Detailed Description

MultiscaleCouplingFunction - The multiscale function for the couplings.

Author
Cristiano Malossi

This simple class provides the implementation for the BC function used by the couplings.

Definition at line 577 of file MultiscaleCoupling.hpp.

Constructor & Destructor Documentation

◆ MultiscaleCouplingFunction() [1/2]

MultiscaleCouplingFunction ( )
inlineexplicit

Constructor.

Definition at line 585 of file MultiscaleCoupling.hpp.

◆ MultiscaleCouplingFunction() [2/2]

MultiscaleCouplingFunction ( const multiscaleCoupling_Type coupling,
const UInt id 
)
inlineexplicit

Constructor.

Parameters
couplingpointer to the coupling
idid of the coupling variable

Definition at line 592 of file MultiscaleCoupling.hpp.

◆ ~MultiscaleCouplingFunction()

virtual ~MultiscaleCouplingFunction ( )
inlinevirtual

Destructor.

Definition at line 595 of file MultiscaleCoupling.hpp.

Member Function Documentation

◆ function()

Real function ( const Real t,
const Real ,
const Real ,
const Real ,
const UInt  
)
inline

Evaluate the coupling quantity.

Returns
evaluation of the function

Definition at line 610 of file MultiscaleCoupling.hpp.

Field Documentation

◆ M_coupling

const multiscaleCoupling_Type* M_coupling
private

Definition at line 622 of file MultiscaleCoupling.hpp.

◆ M_couplingID

UInt M_couplingID
private

Definition at line 623 of file MultiscaleCoupling.hpp.


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