This structure stores the SDK variables defined in PanPhaseField. More...

#include <pfm_sdk.h>

Public Member Functions
int	set_variable_value (const char *var, double val)
	Set a value "val" for the SDK variable "var". More...

void	print_all_variables (FILE *fp)
	For printing all the SDK variables. More...

Public Attributes
size_t	num_variables

char	var_names [256][64]

double	var_values [256]

Detailed Description

This structure stores the SDK variables defined in PanPhaseField.

PanPhaseField has internal state variables like time ("time") and Temperature ("T"). In addition, the users can have user-defined variables defined in *.pfdb file. The input parameters *.pfdb file can be a function of these variables. These variables can be extracted using PFM_SDK::PFDB_variables() method. An example of such a dynamic parameter varying during the simulation is implemented in USER_PFM_PURE_SOLIDIFICATION plugin.

See also: PFM_SDK::PFDB_variables(PFM_SDK_Variables* variables, char* msg)

Member Function Documentation

◆ set_variable_value()

int PFM_SDK_Variables::set_variable_value	(	const char *	var,
		double	val
	)

inline

Set a value "val" for the SDK variable "var".

Parameters

[in]	var
[in]	val

Returns: 0 - Success.
1 - Error. (likely because the variable does not exist)

◆ print_all_variables()

void PFM_SDK_Variables::print_all_variables ( FILE * fp )

inline

For printing all the SDK variables.

Parameters

[in] fp FILE point to the print the SDK variable

Member Data Documentation

◆ num_variables

size_t PFM_SDK_Variables::num_variables

Number of SDK variables defined.

◆ var_names

char PFM_SDK_Variables::var_names[256][64]

An array of the names of the SDK variables.

◆ var_values

double PFM_SDK_Variables::var_values[256]

An array of the values of the SDK variables

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

pfm_sdk.h

Public Member Functions

Public Attributes