METHOD
Public Member Functions | Public Attributes | List of all members
IMEX2Arguments Class Reference

#include <IMEX2Args.h>

Inheritance diagram for IMEX2Arguments:
Inheritance graph
[legend]
Collaboration diagram for IMEX2Arguments:
Collaboration graph
[legend]

Public Member Functions

 IMEX2Arguments ()
 
 IMEX2Arguments (Data *data)
 
 IMEX2Arguments (IMEX2Arguments &args)
 
virtual ~IMEX2Arguments ()
 
IMEX2Arguments & operator= (const IMEX2Arguments &args)
 

Public Attributes

Data * data
 
double gam
 
double om2gam
 
double dt
 
int allocd
 
int i
 
int j
 
int k
 
double * cons
 
double * prims
 
double * aux
 
double * source
 
double * source1
 
double * flux1
 
double * source2
 
double * flux2
 

Detailed Description

IMEX-SSP2 Arguments class

Implicit-Explicit rootfinder requires additional work arrays for the residual functions. These work arrays are located within this classes member data along with necessary constants for each stage.

Definition at line 13 of file IMEX2Args.h.

Constructor & Destructor Documentation

◆ IMEX2Arguments() [1/3]

IMEX2Arguments::IMEX2Arguments ( )
inline

Default constructor.

Sets the allocd flag to false and defines the integration constants.

Definition at line 35 of file IMEX2Args.h.

◆ IMEX2Arguments() [2/3]

IMEX2Arguments::IMEX2Arguments ( Data *  data)

Parameterized constructor.

Allocates arrays for the interstage work arrays and stores pointer to Data class for this simulation. Once memory has been allocated to work arrays the member allocd is set to true (1).

Parameters
[in]*datapointer to the Data class

◆ IMEX2Arguments() [3/3]

IMEX2Arguments::IMEX2Arguments ( IMEX2Arguments &  args)

Deep copy constructor.

Performs a deep copy of all data in the pointed to IMEX2Arguments class to this instance. If this instance has allocd set as false, the arrays will be allocated and allocd set to true. Copy constructor is required for the overload assignment operator.

Parameters
&argspointer to IMEX2Arguments class that needs to be copied

◆ ~IMEX2Arguments()

virtual IMEX2Arguments::~IMEX2Arguments ( )
virtual

Destructor.

Frees allocated memory.

Member Function Documentation

◆ operator=()

IMEX2Arguments& IMEX2Arguments::operator= ( const IMEX2Arguments &  args)

Overload assignment operator.

Performs deep copy of the pointed to IMEX2Arguments class on assignment.

Parameters
&argsaddress of IMEX2Arguments class that is to be copied

Member Data Documentation

◆ allocd

int IMEX2Arguments::allocd

Signifies is the prim aux and source arrays have been allocated memory. 1 if allocated, 0 otherwise.

Definition at line 28 of file IMEX2Args.h.

◆ aux

double * IMEX2Arguments::aux

Pointers to arrays of specified variables. Size is Nvars*Nx*Ny*Nz.

Definition at line 21 of file IMEX2Args.h.

◆ cons

double* IMEX2Arguments::cons

Pointers to arrays of specified variables. Size is Nvars*Nx*Ny*Nz.

Definition at line 21 of file IMEX2Args.h.

◆ data

Data* IMEX2Arguments::data

Pointer to Data class containing global simulation data.

Definition at line 17 of file IMEX2Args.h.

◆ dt

double IMEX2Arguments::dt

Size of the timestep.

Definition at line 21 of file IMEX2Args.h.

◆ flux1

double * IMEX2Arguments::flux1

Pointers to arrays of specified variables. Size is Nvars*Nx*Ny*Nz.

Definition at line 21 of file IMEX2Args.h.

◆ flux2

double * IMEX2Arguments::flux2

Pointers to arrays of specified variables. Size is Nvars*Nx*Ny*Nz.

Definition at line 21 of file IMEX2Args.h.

◆ gam

double IMEX2Arguments::gam

IMEX2/3 constant, gamma=0.2928932188134525)

Definition at line 21 of file IMEX2Args.h.

◆ i

int IMEX2Arguments::i

Definition at line 28 of file IMEX2Args.h.

◆ j

int IMEX2Arguments::j

Definition at line 28 of file IMEX2Args.h.

◆ k

int IMEX2Arguments::k

Which cell is currently being solved.

Definition at line 28 of file IMEX2Args.h.

◆ om2gam

double IMEX2Arguments::om2gam

IMEX2/3 constant, (o)ne (m)inus 2 (gam)ma = 1-2*gamma.

Definition at line 21 of file IMEX2Args.h.

◆ prims

double * IMEX2Arguments::prims

Pointers to arrays of specified variables. Size is Nvars*Nx*Ny*Nz.

Definition at line 21 of file IMEX2Args.h.

◆ source

double * IMEX2Arguments::source

Pointers to arrays of specified variables. Size is Nvars*Nx*Ny*Nz.

Definition at line 21 of file IMEX2Args.h.

◆ source1

double * IMEX2Arguments::source1

Pointers to arrays of specified variables. Size is Nvars*Nx*Ny*Nz.

Definition at line 21 of file IMEX2Args.h.

◆ source2

double * IMEX2Arguments::source2

Pointers to arrays of specified variables. Size is Nvars*Nx*Ny*Nz.

Definition at line 21 of file IMEX2Args.h.

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