Linear coefficient interpolator. More...

#include <CoefficientInterpolatorLinear.H>

Inheritance diagram for CoefficientInterpolatorLinear:

Public Member Functions
	CoefficientInterpolatorLinear (int a_numComps=1)
	default constructor

virtual void	interpolate (LevelData< FArrayBox > &a_result, Real a_time)
	Interpolate in time.

virtual void	interpolate (LevelData< FArrayBox > &a_result, const LevelData< FArrayBox > &a_solution, Real a_time)

virtual bool	dependsUponSolution () const

virtual void	interpolatePrime (LevelData< FArrayBox > &a_prime, const LevelData< FArrayBox > &a_solution, Real a_time)

virtual void	solve (LevelData< FArrayBox > &a_phi, const LevelData< FArrayBox > &a_f, Real a_time, const LevelData< FArrayBox > &a_phi0, Real a_tolerance)

void	define (RefCountedPtr< LevelData< FArrayBox > > a_coefOld, RefCountedPtr< LevelData< FArrayBox > > a_coefNew, Real a_timeOld, Real a_timeNew)
	Define coefficients.

Public Member Functions inherited from CoefficientInterpolator< LevelData< FArrayBox >, LevelData< FArrayBox > >
	CoefficientInterpolator (int a_numComps)

int	numComps () const

void	NewtonRaphson (SolutionLevelDataType &a_phi, const SolutionLevelDataType &a_f, Real a_time, const SolutionLevelDataType &a_phi0, Real a_tolerance)

Public Attributes
RefCountedPtr< LevelData< FArrayBox > >	m_coefOld
	Coefficient at old time.

RefCountedPtr< LevelData< FArrayBox > >	m_coefNew
	Coefficient at new time.

Real	m_timeOld
	Old time.

Real	m_timeNew
	New time.

Additional Inherited Members
Public Types inherited from CoefficientInterpolator< LevelData< FArrayBox >, LevelData< FArrayBox > >
typedef LevelData< FArrayBox >	LevelDataType

typedef LevelData< FArrayBox >	SolutionLevelDataType

Detailed Description

Linear coefficient interpolator.

Class to get time depdendent coefficients by interpolating linearly in time.

Member Function Documentation

◆ dependsUponSolution()

bool CoefficientInterpolatorLinear::dependsUponSolution ( ) const

virtual

Returns true if the coefficient depends on the solution to the partial differential equation (rendering it nonlinear), false otherwise. By default, the coefficient is assumed not to depend upon the solution.

Reimplemented from CoefficientInterpolator< LevelData< FArrayBox >, LevelData< FArrayBox > >.

◆ interpolate()

void CoefficientInterpolatorLinear::interpolate	(	LevelData< FArrayBox > &	a_result,
		const LevelData< FArrayBox > &	a_solution,
		Real	a_time
	)

virtual

Interpolate the coefficient at the given time, placing the result in the given LevelData object. This method assumes that the coefficient depends upon the solution to the partial differential equation in question, so the solution is passed into it as an argument.

Parameters

a_result	The LevelData object that will store the result.
a_solution	The solution to the partial differential equation.
a_time	The time at which the coefficient is to be evaluated.

Reimplemented from CoefficientInterpolator< LevelData< FArrayBox >, LevelData< FArrayBox > >.

◆ interpolatePrime()

void CoefficientInterpolatorLinear::interpolatePrime	(	LevelData< FArrayBox > &	a_prime,
		const LevelData< FArrayBox > &	a_solution,
		Real	a_time
	)

virtual

Computes the derivative of the coefficient with respect to the solution at the desired time. By default, this sets a_deriv to 0.

Parameters

a_prime	The coefficient derivative data will be stored here.
a_solution	The solution to the partial differential equation.
a_time	The time at which to compute the coefficient data.

Reimplemented from CoefficientInterpolator< LevelData< FArrayBox >, LevelData< FArrayBox > >.

◆ solve()

void CoefficientInterpolatorLinear::solve	(	LevelData< FArrayBox > &	a_phi,
		const LevelData< FArrayBox > &	a_f,
		Real	a_time,
		const LevelData< FArrayBox > &	a_phi0,
		Real	a_tolerance
	)

virtual

This virtual void method performs the iterative nonlinear solve $A(\phi) \phi - f(\vec{x}) = 0$ for $\phi$ .

Parameters

a_phi	The solution to the equation, $\phi$ , will be stored here.
a_f	The term $f(\vec{x})$ in the equation.
a_time	The time at which the equation is solved.
a_phi0	The initial estimate for $\phi$ .
a_tolerance	The threshold for the error in the equation that dictates when iteration should cease.

Reimplemented from CoefficientInterpolator< LevelData< FArrayBox >, LevelData< FArrayBox > >.

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

/home/parkinsonjl/mushy-layer/src/CoefficientInterpolatorLinear.H
/home/parkinsonjl/mushy-layer/src/CoefficientInterpolatorLinear.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ dependsUponSolution()

◆ interpolate()

◆ interpolatePrime()

◆ solve()