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

#include <backRKArgs.h>

Collaboration diagram for BackRKArguments:
Collaboration graph
[legend]

Public Member Functions

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

Public Attributes

Data * data
 
double dt
 
int allocd
 
double * constar
 
double * primstar
 
double * auxstar
 
double * sourcestar
 
int i
 
int j
 
int k
 

Detailed Description

BackwardsRK Arguments class

Implicit rootfinder requires additional arrays to hold the primitive, aux, and source vectors due to the guess in the residual function. These arrays lie within this class.
See also
BackwardsRK2

Definition at line 15 of file backRKArgs.h.

Constructor & Destructor Documentation

◆ BackRKArguments() [1/3]

BackRKArguments::BackRKArguments ( )
inline

Default constructor.

Sets the allocd variable to zero. No arrays exist at this point.

Definition at line 38 of file backRKArgs.h.

◆ BackRKArguments() [2/3]

BackRKArguments::BackRKArguments ( Data *  data)

Parameterized constructor.

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

Parameters
[in]*dataPointer to Data class

◆ BackRKArguments() [3/3]

BackRKArguments::BackRKArguments ( BackRKArguments &  args)

Deep copy constructor.

Performs a deep copy of all data in the pointed to BackRKArguments 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 BackRKArguments class that needs to be copied

◆ ~BackRKArguments()

virtual BackRKArguments::~BackRKArguments ( )
virtual

Destructor.

Frees allocated memory.

Member Function Documentation

◆ operator=()

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

Overload assignment operator.

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

Parameters
&argsaddress of BackRKArguments class that is to be copied

Member Data Documentation

◆ allocd

int BackRKArguments::allocd

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

Definition at line 29 of file backRKArgs.h.

◆ auxstar

double * BackRKArguments::auxstar

< Interstage work array for specified variable

Definition at line 24 of file backRKArgs.h.

◆ constar

double* BackRKArguments::constar

< Interstage work array for specified variable

Definition at line 24 of file backRKArgs.h.

◆ data

Data* BackRKArguments::data

Pointer to Data class containing global simulation data.

Definition at line 19 of file backRKArgs.h.

◆ dt

double BackRKArguments::dt

Size of current timestep.

Definition at line 24 of file backRKArgs.h.

◆ i

int BackRKArguments::i

Which cell is currently being solved.

Definition at line 29 of file backRKArgs.h.

◆ j

int BackRKArguments::j

Which cell is currently being solved.

Definition at line 29 of file backRKArgs.h.

◆ k

int BackRKArguments::k

Which cell is currently being solved.

Definition at line 29 of file backRKArgs.h.

◆ primstar

double * BackRKArguments::primstar

< Interstage work array for specified variable

Definition at line 24 of file backRKArgs.h.

◆ sourcestar

double * BackRKArguments::sourcestar

< Interstage work array for specified variable

Definition at line 24 of file backRKArgs.h.

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