#include <ADRData.hpp>

Collaboration diagram for DataADR:

Private Attributes
Real	M_diffusionCoefficient
	Physics. More...

Real	M_reactionCoefficient

Real	M_steady

UInt	M_solutionFieldDimension

TimeData_ptr_type	M_TimeDataPtr
	Data container for time parameters. More...

UInt	M_verbose
	Miscellaneous parameters. More...

std::string	M_solFEType
	Type of finite element (P1, P2, ...) for the solution. More...

StringDataList	M_stabilization_list
	Type of finite element (P1, P2, ...) for the advection field. More...

ADRStabilization	M_stabilizationMethod

Real	M_stabilizationCoefficient

Public Types
typedef TimeData	TimeData_type
	The time data handler. More...

typedef std::shared_ptr< TimeData_type >	TimeData_ptr_type

Constructors & Destructor
	DataADR ()
	Empty Constructor. More...

	DataADR (const DataADR &dataADR)
	Copy constructor. More...

Methods
void	setup (const GetPot &dataFile, const std::string &section="adr")
	Read the dataFile and set all the internal quantities. More...

void	showMe (std::ostream &output=std::cout) const
	Display the internal values. More...

Operators
DataADR &	operator= (const DataADR &dataADR)
	Operator=. More...

Set methods
void	setDiffusionCoefficient (const Real &diffusionCoefficient)

void	setReactionCoefficient (const Real &reactionCoefficient)

void	setSteady (const Real &steady)

void	setTimeDataPtr (const TimeData_ptr_type TimeDataPtr)
	Set data time container. More...

void	setFieldDimension (const UInt &fieldDim)

void	setStabilizationMethod (const ADRStabilization &stabMethod)

void	setStabilizationCoefficient (const Real &stabCoeff)

Get methods
const Real &	diffusionCoefficient () const

const Real &	reactionCoefficient () const

const Real &	steady () const

TimeData_ptr_type	TimeDataPtr (void) const
	Get data time container. More...

const UInt &	solutionFieldDimension () const

const UInt &	verbose () const

const std::string &	solFEType () const

const ADRStabilization &	stabilizationMethod () const

const Real &	stabilizationCoefficient () const

Detailed Description

Base class which holds usual data for the ADR equations solvers

Definition at line 68 of file ADRData.hpp.

Member Typedef Documentation

◆ TimeData_type

typedef TimeData TimeData_type

The time data handler.

The class DataADR "has a" time handler object, to manage time dependent problems.

Definition at line 80 of file ADRData.hpp.

◆ TimeData_ptr_type

typedef std::shared_ptr<TimeData_type> TimeData_ptr_type

Definition at line 81 of file ADRData.hpp.

Constructor & Destructor Documentation

◆ DataADR() [1/2]

DataADR ( )

Empty Constructor.

Definition at line 38 of file ADRData.cpp.

Here is the caller graph for this function:

◆ DataADR() [2/2]

DataADR ( const DataADR & dataADR )

Copy constructor.

Parameters

dataADR an object of type DataADR

Definition at line 58 of file ADRData.cpp.

Here is the caller graph for this function:

Member Function Documentation

◆ setup()

void setup	(	const GetPot &	dataFile,
		const std::string &	section = `"adr"`
	)

Read the dataFile and set all the internal quantities.

Parameters

dataFile	data file
section	section of the file

Definition at line 79 of file ADRData.cpp.

◆ showMe()

void showMe ( std::ostream & output = std::cout ) const

Display the internal values.

Definition at line 109 of file ADRData.cpp.

◆ operator=()

DataADR& operator= ( const DataADR & dataADR )

Operator=.

Parameters

dataADR an object of type DataADR

◆ setDiffusionCoefficient()

void setDiffusionCoefficient ( const Real & diffusionCoefficient )

inline

Definition at line 128 of file ADRData.hpp.

◆ setReactionCoefficient()

void setReactionCoefficient ( const Real & reactionCoefficient )

inline

Definition at line 133 of file ADRData.hpp.

◆ setSteady()

void setSteady ( const Real & steady )

inline

Definition at line 138 of file ADRData.hpp.

◆ setTimeDataPtr()

void setTimeDataPtr ( const TimeData_ptr_type TimeDataPtr )

inline

Set data time container.

Parameters

TimeData shared_ptr to TimeData container

Definition at line 147 of file ADRData.hpp.

◆ setFieldDimension()

void setFieldDimension ( const UInt & fieldDim )

inline

Definition at line 152 of file ADRData.hpp.

◆ setStabilizationMethod()

void setStabilizationMethod ( const ADRStabilization & stabMethod )

inline

Definition at line 157 of file ADRData.hpp.

◆ setStabilizationCoefficient()

void setStabilizationCoefficient ( const Real & stabCoeff )

inline

Definition at line 162 of file ADRData.hpp.

◆ diffusionCoefficient()

const Real& diffusionCoefficient ( ) const

inline

Definition at line 171 of file ADRData.hpp.

◆ reactionCoefficient()

const Real& reactionCoefficient ( ) const

inline

Definition at line 176 of file ADRData.hpp.

◆ steady()

const Real& steady ( ) const

inline

Definition at line 181 of file ADRData.hpp.

◆ TimeDataPtr()

TimeData_ptr_type TimeDataPtr ( void ) const

inline

Get data time container.

Definition at line 187 of file ADRData.hpp.

◆ solutionFieldDimension()

const UInt& solutionFieldDimension ( ) const

inline

Definition at line 192 of file ADRData.hpp.

◆ verbose()

const UInt& verbose ( ) const

inline

Definition at line 197 of file ADRData.hpp.

◆ solFEType()

const std::string& solFEType ( ) const

inline

Definition at line 202 of file ADRData.hpp.

◆ stabilizationMethod()

const ADRStabilization& stabilizationMethod ( ) const

inline

Definition at line 209 of file ADRData.hpp.

◆ stabilizationCoefficient()

const Real& stabilizationCoefficient ( ) const

inline

Definition at line 214 of file ADRData.hpp.

Field Documentation

◆ M_diffusionCoefficient

Real M_diffusionCoefficient

private

Physics.

Definition at line 224 of file ADRData.hpp.

◆ M_reactionCoefficient

Real M_reactionCoefficient

private

Definition at line 225 of file ADRData.hpp.

◆ M_steady

Real M_steady

private

Definition at line 226 of file ADRData.hpp.

◆ M_solutionFieldDimension

UInt M_solutionFieldDimension

private

Definition at line 227 of file ADRData.hpp.

◆ M_TimeDataPtr

TimeData_ptr_type M_TimeDataPtr

private

Data container for time parameters.

Definition at line 230 of file ADRData.hpp.

◆ M_verbose

UInt M_verbose

private

Miscellaneous parameters.

Definition at line 233 of file ADRData.hpp.

◆ M_solFEType

std::string M_solFEType

private

Type of finite element (P1, P2, ...) for the solution.

Definition at line 236 of file ADRData.hpp.

◆ M_stabilization_list

StringDataList M_stabilization_list

private

Type of finite element (P1, P2, ...) for the advection field.

Discretization

Definition at line 241 of file ADRData.hpp.

◆ M_stabilizationMethod

ADRStabilization M_stabilizationMethod

private

Definition at line 242 of file ADRData.hpp.

◆ M_stabilizationCoefficient

Real M_stabilizationCoefficient

private

Definition at line 244 of file ADRData.hpp.

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

Private Attributes

Public Types

Constructors & Destructor

Methods

Operators

Set methods

Get methods

Detailed Description

Member Typedef Documentation

◆ TimeData_type

◆ TimeData_ptr_type

Constructor & Destructor Documentation

◆ DataADR() [1/2]

◆ DataADR() [2/2]

Member Function Documentation

◆ setup()

◆ showMe()

◆ operator=()

◆ setDiffusionCoefficient()

◆ setReactionCoefficient()

◆ setSteady()

◆ setTimeDataPtr()

◆ setFieldDimension()

◆ setStabilizationMethod()

◆ setStabilizationCoefficient()

◆ diffusionCoefficient()

◆ reactionCoefficient()

◆ steady()

◆ TimeDataPtr()

◆ solutionFieldDimension()

◆ verbose()

◆ solFEType()

◆ stabilizationMethod()

◆ stabilizationCoefficient()

Field Documentation

◆ M_diffusionCoefficient

◆ M_reactionCoefficient

◆ M_steady

◆ M_solutionFieldDimension

◆ M_TimeDataPtr

◆ M_verbose

◆ M_solFEType

◆ M_stabilization_list

◆ M_stabilizationMethod

◆ M_stabilizationCoefficient