OptimizationTable Class is used to obtain optimization parameters or for settings.
The class can be called from Study or AnalysisGroup class.
. More...

Public Member Functions
void	AddExpressionItem (String &parameterName)
	Adds a constraint condition object. More...

void	AddInitialCase (int caseIndex)
	Adds an existing case to use. More...

void	AddObjectiveItem (String &parameterName)
	Adds an objective function object. More...

void	AddParametricItem (String &parameterName)
	Adds an object to the parametric variable range. More...

void	AddTopologyObjectiveItem ()
	Adds a topology objective function object.

bool	AlwaysCheckConflict ()
	Corresponds to the function OptimizationTable::IsCheckConflict . More...

void	ClearMagnetDirection ()
	Clears the optimization settings for the magnetization direction.

int	CoresPerNode ()
	Returns the number of cores per node to be used when executing the calculation. More...

String	CpuGroup ()
	Specifies the CPU group for running a calculation. More...

int	CreateInitialCases ()
	Specifies the method to automatically create an initial case. More...

String	CSVOutputPath ()
	Returns the CSV Output Path.

bool	DeleteRemoteFiles ()
	Returns whether or not to delete a remote file. More...

bool	DeleteScratchFiles ()
	Returns whether or not to delete the local scratch directory. More...

void	ExportOptimizationRange (String &csvFile)
	Exports parametric variable range. More...

ExpressionItem *	GetExpressionItem (Variant &indexOrName)
	Returns the constraint condition object. More...

ExpressionItem *	GetObjectiveItem (Variant &indexOrName)
	Returns the objective function object. More...

Variant	GetParameter (String &key)
	Returns the value of a specified parameter. More...

ParametricRange *	GetParametricItem (Variant &indexOrName)
	Returns an object in the parametric variable range. More...

ParametricRange *	GetParametricItemByParameterName (String &parameterName)
	Returns an object in the parametric variable range from parameter name. More...

Variant	GetRangeStringList (Variant &indexOrName, String &parameter)
	Get the range table string values for optimization. More...

Variant	GetRangeValue (Variant &indexOrName, String &parameter)
	Set the range values for optimization. More...

Variant	GetRangeValueList (Variant &indexOrName, String &parameter)
	Get the range table values for optimization. More...

TopologyObjectiveItem *	GetTopologyObjectiveItem (Variant &indexOrName)
	Returns the topology objective function object. More...

String	HostsFile ()
	Returns the hosts file. More...

void	ImportOptimizationRange (String &csvFile)
	Imports parametric variable range. More...

void	ImportOptimizationRangeFromRangeOptimizationResult ()
	Imports parametric variable range by CAD parameter range results.

bool	IsCheckConflict ()
	Returns whether or not to run a calculation when running a conflict check. More...

bool	IsIgnoreGeometryError ()
	Returns whether or not to ignore the geometry error when running a conflict check. More...

bool	IsImmediateCSVOutput ()
	Returns True if objectives is set to be written to CSV file once calculation is completed. More...

bool	IsValid ()
	Returns True if an object is valid. More...

int	JobSystemTimeoutMaxRetry ()
	Returns maximum number of retries. More...

int	JobSystemTimeoutTime ()
	Returns the timeout time (min). More...

String	LicenseLimits ()
	Returns the license name and maximum license usage. More...

String	LSFOptions ()
	Returns the LSF options. More...

String	LSFQueue ()
	Returns LSF queue. More...

String	Machine ()
	Specifies the machine name when running a calculation. More...

String	MagnetDirectionCoordinate ()
	Returns the name of the coordinate system for optimizing the magnetization direction. More...

String	MagnetDirectionGroup (int index)
	Returns the name of the set of direction of the magnetization orientation optimization. More...

double	MagnetDirectionMax (int index)
	Returns the maximum value in the direction for optimization of the magnetization direction. More...

double	MagnetDirectionMin (int index)
	Returns the minimum value in the direction for optimization of the magnetization direction. More...

String	MagnetDirectionType (int index)
	Returns the type name of the direction of optimization of the magnetization direction. More...

int	MaxCases ()
	Obsolete function. More...

int	NewCasesPerLoop ()
	Obsolete function. More...

String	NGnetWeightOutputPath ()
	Returns the CSV output path for the NGnet weight value.

int	NumExpressions ()
	Returns the number of constraint conditions as an integer. More...

int	NumJobs ()
	Returns the number of jobs to run a calculation. More...

int	NumNodes ()
	Returns the number of nodes to be used when executing the calculation. More...

int	NumObjectives ()
	Returns the number of objective functions as an integer. More...

int	NumParameters ()
	Returns the number of parameters as an integer. More...

int	NumSimultaneousStudies ()
	Returns the number of concurrent execution studies when executing the foreground calculation. More...

bool	OptimizeMagnetDirection ()
	Returns whether to optimize the magnetization direction. More...

String	PBSQueue ()
	Returns the PBS queue. More...

String	PBSResource ()
	Returns the PBS resource. More...

bool	PreProcessOnWrite ()
	Returns whether or not to pre process to submit jcf. More...

void	RemoveAllCases ()
	Removes all existing cases to use.

void	RemoveExpressionItem (Variant &indexOrName)
	Deletes the contstraint condition object. More...

void	RemoveObjectiveItem (Variant &indexOrName)
	Deletes an objective function object. More...

void	RemoveParametricItem (Variant &indexOrName)
	Deletes an object in the parametric variable range. More...

void	RemoveTopologyObjectiveItem (Variant &indexOrName)
	Deletes a topology objective function object. More...

String	ReservationKey ()
	Returns the dynamic license reservation key.

String	RestartFileOutputPath ()
	Returns the Optimization Restart File(.sav) Path.

String	ResubmitCpuGroup ()
	Specifies the CPU group for resubmitted calculations. More...

String	ResubmitMachine ()
	Specifies the machine name for resubmitted calculations. More...

bool	RunAsProject ()
	Returns whether or not to send a project file. More...

bool	SendSSHSettings ()
	Returns whether or not to send SSH Settings. More...

void	SetAlwaysCheckConflict (bool isAlways)
	Corresponds to the function OptimizationTable::SetCheckConflict . More...

void	SetCheckConflict (bool flag)
	Specifies whether or not to run an conflict check when running a calculation. More...

void	SetCheckOn (Variant &value, bool checkOn)
	Specifies whether parametric variable range is used during optimization. More...

void	SetCoresPerNode (int coresPerNode)
	Specifies the upper limit of CPU cores that can be used for calculations on each computation node. More...

void	SetCpuGroup (String &group)
	Specifies the CPU group to run a calculation. More...

void	SetCreateInitialCases (int create)
	Specifies the method to automatically create an initial case. More...

void	SetCSVOutputPath (String &filePath)
	Specifies the CSV output filepath for optimization monitoring without GUI. More...

void	SetDeleteRemoteFiles (bool doDelete)
	Specifies whether or not to delete a remote file. More...

void	SetDeleteScratchFiles (bool doDelete)
	Specifies whether or not to delete the local scratch directory. More...

void	SetHostsFile (String &hostsFile)
	Specifies hosts file. More...

void	SetIgnoreGeometryError (bool flag)
	Specifies whether or not to ignore the geometry error when running a calculation. More...

void	SetImmediateCSVOutput (bool immediateOutput)
	Specifies whether to write to CSV file in case order or once calculation is done. More...

void	SetJobSystemTimeoutMaxRetry (int maxRetry)
	Specifies maximum number of retries. More...

void	SetJobSystemTimeoutTime (double timeoutTime)
	Specifies the timeout time (min). More...

void	SetKeepRemoteFiles (Variant &value)
	Specifies whether or not results are kept in management server. More...

void	SetLicenseLimits (String &licenseLimits)
	Specifies maximum license to be used for selected licenses. More...

void	SetLSFOptions (String &lsfOptions)
	Specifies LSF options. More...

void	SetLSFQueue (String &lsfQueue)
	Specifies LSF queue. More...

void	SetMachine (String &machine)
	Specifies the machine name to run a calculation. More...

void	SetMagnetDirectionCoordinate (String &exp)
	Specifies the coordinate system for optimizing the magnetization direction. More...

void	SetMagnetDirectionGroup (int index, String &exp)
	Specifies a set of Directions for optimization of the magnetization direction. More...

void	SetMagnetDirectionMax (int index, double value)
	Specifies the maximum value in the Direction for optimization of the magnetization direction. More...

void	SetMagnetDirectionMin (int index, double value)
	Specifies the minimum value in the Direction for optimization of the magnetization direction. More...

void	SetMagnetDirectionType (int index, String &exp)
	Specifies the direction of optimization of the magnetization direction. More...

void	SetMaxCases (int cases)
	Obsolete function. More...

void	SetNewCasesPerLoop (int cases)
	Obsolete function. More...

void	SetNGnetWeightOutputPath (String &filePath)
	Specifies the CSV output path for the NGnet weight value. More...

void	SetNumJobs (int numJobs)
	Specifies the number of jobs to run a calculation. More...

void	SetNumNodes (int numNodes)
	Specifies the upper limit of computation nodes to be used. More...

void	SetOptimizeMagnetDirection (bool optimize)
	Specifies whether to optimize the magnetization direction. More...

void	SetParameter (String &key, Variant &value)
	Specifies the value of a specified parameter. More...

void	SetPBSQueue (String &pbsQueue)
	Specifies PBS queue. More...

void	SetPBSResource (String &pbsResource)
	Specifies PBS resource. More...

void	SetPreProcessOnWrite (bool set)
	Specifies whether to pre process to submit jcf. More...

void	SetRangeStringList (Variant &indexOrName, String &parameter, StringList &array)
	Set the range table string values for optimization. More...

void	SetRangeValue (Variant &indexOrName, String &parameter, Variant &value)
	Set the range values for optimization. More...

void	SetRangeValueList (Variant &indexOrName, String &parameter, String array &array)
	Set the range table values for optimization. More...

void	SetReservationKey (String &key)
	Specifies the license reservation key for the calculation. More...

void	SetRestartDataFromFile (String &filePath)
	Specifies the restart data from the restart data file. More...

void	SetRestartFileOutputPath (String &restartFilePath)
	Specifies the restart file to resume optimization from last iteration. More...

void	SetResubmitCpuGroup (String &group)
	Specifies the CPU group for resubmitted calculations. More...

void	SetResubmitMachine (String &machine)
	Specifies the machine name to resubmit calculations to. More...

void	SetRunAsProject (bool asProject)
	Specifies whether or not to send a project file. More...

void	SetSendSSHSettings (bool sendSettings)
	Specifies whether to send SSH Settings to remote machine. More...

void	SetSimultaneousStudies (int value)
	Specifies the number of studies to be executed concurrently when executing the foreground calculation. More...

void	SetSlurmOptions (String &slurmOptions)
	Specifies Slurm options. More...

void	SetStopOnFailedCase (bool stop)
	Specifies whether or not to stop the calculation when an error occurs. More...

void	SetTolerance (double tolerance)
	Obsolete function. More...

void	SetUseJobSystem (bool useJobSystem)
	Specifies whether to use JMAG Job system. More...

void	SetUseJobSystemTimeout (bool useTimeout)
	Specifies whether to use timeout of analysis job. More...

void	SetUseLicenseControl (bool useLicenseControl)
	Specifies whether to use License Control. More...

void	SetUseLocalCalculationFolder (bool use)
	Specifies whether or not to batch execution with local calculation folder. More...

void	SetUseMultiLicense (bool useMultiLicense)
	Specifies if the calculation should use the LM-X multi-calculation license. More...

String	SlurmOptions ()
	Returns the Slurm options. More...

bool	StopOnFailedCase ()
	Specifies whether or not to stop a calculation when running a calculation. More...

double	Tolerance ()
	Obsolete function. More...

bool	UseJobSystem ()
	Returns whether or not to use JMAG job system. More...

bool	UseJobSystemTimeout ()
	Returns whether to use timeout of analysis job. More...

bool	UseLicenseControl ()
	Returns whether or not to use license control. More...

bool	UseLocalCalculationFolder ()
	Specifies whether or not to batch execution with local calculation folder. More...

bool	UseMultiLicense ()
	Returns True if the multi-calculation license flag is set.

Detailed Description

OptimizationTable Class is used to obtain optimization parameters or for settings.
The class can be called from Study or AnalysisGroup class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetOptimizationTable()

Member Function Documentation

void OptimizationTable::AddExpressionItem ( String & parameterName )

Adds a constraint condition object.

Parameters

parameterName Description

void OptimizationTable::AddInitialCase ( int caseIndex )

Adds an existing case to use.

Parameters

caseIndex Case number

The caseIndex is numbered from 1.

void OptimizationTable::AddObjectiveItem ( String & parameterName )

Adds an objective function object.

Parameters

parameterName Description

void OptimizationTable::AddParametricItem ( String & parameterName )

Adds an object to the parametric variable range.

Parameters

parameterName Name of the parameter

bool OptimizationTable::AlwaysCheckConflict ( )

Corresponds to the function OptimizationTable::IsCheckConflict .

Deprecated:: Returns whether or not to run a calculation when running a conflict check.

int OptimizationTable::CoresPerNode ( )

Returns the number of cores per node to be used when executing the calculation.

Returns: Number of cores per node

String OptimizationTable::CpuGroup ( )

Specifies the CPU group for running a calculation.

Returns: CPU group

int OptimizationTable::CreateInitialCases ( )

Specifies the method to automatically create an initial case.

Returns: Method

0 = Use Only Existing Cases

1 = Orthogonal Array

2 = 3-Level Matrix

bool OptimizationTable::DeleteRemoteFiles ( )

Returns whether or not to delete a remote file.

Returns: Whether or not to remove

bool OptimizationTable::DeleteScratchFiles ( )

Returns whether or not to delete the local scratch directory.

Returns: Whether or not to remove

void OptimizationTable::ExportOptimizationRange ( String & csvFile )

Exports parametric variable range.

Parameters

csvFile csv file

ExpressionItem * OptimizationTable::GetExpressionItem ( Variant & val )

Returns the constraint condition object.

Parameters

val	Description or index

Returns: ExpressionItem object

ExpressionItem * OptimizationTable::GetObjectiveItem ( Variant & val )

Returns the objective function object.

Parameters

val	Description or index

Returns: ExpressionItem object

Variant OptimizationTable::GetParameter ( String & key )

Returns the value of a specified parameter.

Parameters

key	Parameter name

Returns: Parameter value

ParametricRange * OptimizationTable::GetParametricItem ( Variant & val )

Returns an object in the parametric variable range.

Parameters

val	Name or index of the parameter

Returns: ParametricRange object

ParametricRange * OptimizationTable::GetParametricItemByParameterName ( String & parameterName )

Returns an object in the parametric variable range from parameter name.

Parameters

parameterName Name of the parameter

Returns: ParametricRange object

Variant OptimizationTable::GetRangeStringList	(	Variant &	indexOrName,
		String &	parameter
	)

Get the range table string values for optimization.

Parameters

indexOrName	Parametric Item Name
parameter	Value Name

Returns: String Array

Variant OptimizationTable::GetRangeValue	(	Variant &	indexOrName,
		String &	parameter
	)

Set the range values for optimization.

Parameters

indexOrName	Parametric Item Name
parameter	Value Name

Returns: Range Value

Variant OptimizationTable::GetRangeValueList	(	Variant &	indexOrName,
		String &	parameter
	)

Get the range table values for optimization.

Parameters

indexOrName	Parametric Item Name
parameter	Value Name

Returns: Array

TopologyObjectiveItem * OptimizationTable::GetTopologyObjectiveItem ( Variant & val )

Returns the topology objective function object.

Parameters

val	Description or index

Returns: TopologyObjectiveItem object

String OptimizationTable::HostsFile ( )

Returns the hosts file.

Returns: Hosts file

void OptimizationTable::ImportOptimizationRange ( String & csvFile )

Imports parametric variable range.

Parameters

csvFile csv file

bool OptimizationTable::IsCheckConflict ( )

Returns whether or not to run a calculation when running a conflict check.

Returns: Whether or not to run a conflict check

bool OptimizationTable::IsIgnoreGeometryError ( )

Returns whether or not to ignore the geometry error when running a conflict check.

Returns: Whether or not to ignore the geometry error

bool OptimizationTable::IsImmediateCSVOutput ( )

Returns True if objectives is set to be written to CSV file once calculation is completed.

Returns: Whether or not the objectives should be written immediately or in case order

bool OptimizationTable::IsValid ( )

Returns True if an object is valid.

Returns: Whether or not the OptimizationTable object is valid

int OptimizationTable::JobSystemTimeoutMaxRetry ( )

Returns maximum number of retries.

Returns: Maximum number of retries

int OptimizationTable::JobSystemTimeoutTime ( )

Returns the timeout time (min).

Returns: Timeout time (min)

String OptimizationTable::LicenseLimits ( )

Returns the license name and maximum license usage.

Returns: License names and their maximum checkout license

String OptimizationTable::LSFOptions ( )

Returns the LSF options.

Returns: LSF options

String OptimizationTable::LSFQueue ( )

Returns LSF queue.

Returns: LSF queue

String OptimizationTable::Machine ( )

Specifies the machine name when running a calculation.

Returns: Machine name

String OptimizationTable::MagnetDirectionCoordinate ( )

Returns the name of the coordinate system for optimizing the magnetization direction.

Returns: Name of the coordinate system

String OptimizationTable::MagnetDirectionGroup ( int index )

Returns the name of the set of direction of the magnetization orientation optimization.

Parameters

index Index

Returns: Set name

double OptimizationTable::MagnetDirectionMax ( int index )

Returns the maximum value in the direction for optimization of the magnetization direction.

Parameters

index Index

Returns: Maximum value

double OptimizationTable::MagnetDirectionMin ( int index )

Returns the minimum value in the direction for optimization of the magnetization direction.

Parameters

index Index

Returns: Minimum value

String OptimizationTable::MagnetDirectionType ( int index )

Returns the type name of the direction of optimization of the magnetization direction.

Parameters

index Index

Returns: Type name

void OptimizationTable::MaxCases ( )

Obsolete function.

Deprecated:

void OptimizationTable::NewCasesPerLoop ( )

Obsolete function.

Deprecated:

int OptimizationTable::NumExpressions ( )

Returns the number of constraint conditions as an integer.

Returns: Number of constraint conditions

int OptimizationTable::NumJobs ( )

Returns the number of jobs to run a calculation.

Returns: Number of jobs

int OptimizationTable::NumNodes ( )

Returns the number of nodes to be used when executing the calculation.

Returns: Number of nodes

int OptimizationTable::NumObjectives ( )

Returns the number of objective functions as an integer.

Returns: Number of objective functions

int OptimizationTable::NumParameters ( )

Returns the number of parameters as an integer.

Returns: Number of parameters

int OptimizationTable::NumSimultaneousStudies ( )

Returns the number of concurrent execution studies when executing the foreground calculation.

Returns: Simultaneous Number of Studies

bool OptimizationTable::OptimizeMagnetDirection ( )

Returns whether to optimize the magnetization direction.

Returns: Whether to optimize the magnetization direction

String OptimizationTable::PBSQueue ( )

Returns the PBS queue.

Returns: PBS queue

String OptimizationTable::PBSResource ( )

Returns the PBS resource.

Returns: PBS resource

bool OptimizationTable::PreProcessOnWrite ( )

Returns whether or not to pre process to submit jcf.

Returns: Whether or not to pre process to submit jcf

void OptimizationTable::RemoveExpressionItem ( Variant & indexOrName )

Deletes the contstraint condition object.

Parameters

indexOrName Description or index

void OptimizationTable::RemoveObjectiveItem ( Variant & indexOrName )

Deletes an objective function object.

Parameters

indexOrName Description or index

void OptimizationTable::RemoveParametricItem ( Variant & indexOrName )

Deletes an object in the parametric variable range.

Parameters

indexOrName Parameter name or index

void OptimizationTable::RemoveTopologyObjectiveItem ( Variant & indexOrName )

Deletes a topology objective function object.

Parameters

indexOrName Description or index

String OptimizationTable::ResubmitCpuGroup ( )

Specifies the CPU group for resubmitted calculations.

Returns: CPU group

String OptimizationTable::ResubmitMachine ( )

Specifies the machine name for resubmitted calculations.

Returns: Machine name

bool OptimizationTable::RunAsProject ( )

Returns whether or not to send a project file.

Returns: Whether or not to send a project file

bool OptimizationTable::SendSSHSettings ( )

Returns whether or not to send SSH Settings.

Returns: Whether or not to send SSH Settings

void OptimizationTable::SetAlwaysCheckConflict ( bool flag )

Corresponds to the function OptimizationTable::SetCheckConflict .

Deprecated:: Specifies whether or not to run an conflict check when running a calculation.

void OptimizationTable::SetCheckConflict ( bool flag )

Specifies whether or not to run an conflict check when running a calculation.

Parameters

flag	Whether to run a conflict check

void OptimizationTable::SetCheckOn	(	Variant &	value,
		bool	checkOn
	)

Specifies whether parametric variable range is used during optimization.

Corresponds to the function OptimizationTable::SetCheckOn .

void OptimizationTable::SetCoresPerNode ( int coresPerNode )

Specifies the upper limit of CPU cores that can be used for calculations on each computation node.

Parameters

coresPerNode Number of cores per node

void OptimizationTable::SetCpuGroup ( String & group )

Specifies the CPU group to run a calculation.

Parameters

group CPU group

void OptimizationTable::SetCreateInitialCases ( int create )

Specifies the method to automatically create an initial case.

Parameters

create

Method
= Use Only Existing Cases
= Orthogonal Array
= 3-Level Matrix

void OptimizationTable::SetCSVOutputPath ( String & filePath )

Specifies the CSV output filepath for optimization monitoring without GUI.

Parameters

key	CSV output filepath

void OptimizationTable::SetDeleteRemoteFiles ( bool doDelete )

Specifies whether or not to delete a remote file.

Parameters

doDelete Whether or not to delete

void OptimizationTable::SetDeleteScratchFiles ( bool doDelete )

Specifies whether or not to delete the local scratch directory.

Parameters

doDelete Whether or not to delete

void OptimizationTable::SetHostsFile ( String & hostsFile )

Specifies hosts file.

Parameters

hostsFile Hosts file

void OptimizationTable::SetIgnoreGeometryError ( bool flag )

Specifies whether or not to ignore the geometry error when running a calculation.

Parameters

flag	Whether to ignore the geometry error

void OptimizationTable::SetImmediateCSVOutput ( bool immediateOutput )

Specifies whether to write to CSV file in case order or once calculation is done.

Parameters

flag	Whether to write to CSV file in case order or once calculation is done

void OptimizationTable::SetJobSystemTimeoutMaxRetry ( int maxRetry )

Specifies maximum number of retries.

Parameters

maxRetry Maximum number of retries

void OptimizationTable::SetJobSystemTimeoutTime ( double timeoutTime )

Specifies the timeout time (min).

Parameters

timeoutTime Timeout time (min)

void OptimizationTable::SetKeepRemoteFiles ( Variant & value )

Specifies whether or not results are kept in management server.

Parameters

value

On : Leaves results on remote machine
Off : Moves results to local machine
Both : Copies to local and leaves on server

void OptimizationTable::SetLicenseLimits ( String & licenseLimits )

Specifies maximum license to be used for selected licenses.

Parameters

licenseLimits Maximum license to be checked out

void OptimizationTable::SetLSFOptions ( String & lsfOptions )

Specifies LSF options.

Parameters

lsfOptions LSF options

void OptimizationTable::SetLSFQueue ( String & lsfQueue )

Specifies LSF queue.

Parameters

lsfQueue LSF queue

void OptimizationTable::SetMachine ( String & machine )

Specifies the machine name to run a calculation.

Parameters

machine Machine name

void OptimizationTable::SetMagnetDirectionCoordinate ( String & exp )

Specifies the coordinate system for optimizing the magnetization direction.

Parameters

exp	Name of the coordinate system

void OptimizationTable::SetMagnetDirectionGroup	(	int	index,
		String &	exp
	)

Specifies a set of Directions for optimization of the magnetization direction.

Parameters

index	Index
exp	Set name

void OptimizationTable::SetMagnetDirectionMax	(	int	index,
		double	value
	)

Specifies the maximum value in the Direction for optimization of the magnetization direction.

Parameters

index	index
value	Maximum value

void OptimizationTable::SetMagnetDirectionMin	(	int	index,
		double	value
	)

Specifies the minimum value in the Direction for optimization of the magnetization direction.

Parameters

index	index
value	Minimum value

void OptimizationTable::SetMagnetDirectionType	(	int	index,
		String &	exp
	)

Specifies the direction of optimization of the magnetization direction.

Parameters

index	Index
exp	Direction Type

void OptimizationTable::SetMaxCases ( int cases )

Obsolete function.

Deprecated:

void OptimizationTable::SetNewCasesPerLoop ( int cases )

Obsolete function.

Deprecated:

void OptimizationTable::SetNGnetWeightOutputPath ( String & filePath )

Specifies the CSV output path for the NGnet weight value.

Parameters

key	CSV output filepath

void OptimizationTable::SetNumJobs ( int numJobs )

Specifies the number of jobs to run a calculation.

Parameters

numJobs Number of jobs

void OptimizationTable::SetNumNodes ( int numNodes )

Specifies the upper limit of computation nodes to be used.

Parameters

numNodes Number of nodes

void OptimizationTable::SetOptimizeMagnetDirection ( bool optimize )

Specifies whether to optimize the magnetization direction.

Parameters

optimize Whether to optimize the magnetization direction

void OptimizationTable::SetParameter	(	String &	key,
		Variant &	value
	)

Specifies the value of a specified parameter.

Parameters

key

Parameter name

key	Type	Description
create_initial_cases	Flag	Creation of Initial Cases

Quadratic Response Surface
1. Select the Optimization engine
  app.GetModel(0).GetStudy(0).GetOptimizationTable().SetParameter("engine", "QuadraticResponseSurface")
2. key list
  
  key Type Description
  
  max_cases Flag Max Iterations
  
  tolerance Double Tolerance

Genetic Algorithm

Select the Optimization engine
app.GetModel(0).GetStudy(0).GetOptimizationTable().SetParameter("engine", "jsol_ga")

key list

key	Type	Description
jsol_ga_max_generation	Flag	Maximum Number of Generations
jsol_ga_num_population	Flag	Population Size
jsol_ga_num_children	Flag	Number of Children
jsol_ga_step_size	Flag	Step-Size Parameter
jsol_ga_stall_generation	Double	Stopping Criteria
jsol_ga_group_cases	Flag	Group Cases by Generation
jsol_ga_group_prefix	String	Prefix
jsol_ga_error_handling	Flag	Apply Penalty to Error Cases
jsol_ga_omit_unnecessary_cases	Flag	Do Not Add Unnecessary Cases Due to Geometry or Constraint Errors
jsol_ga_use_range_optimization	Flag	Update CAD Parameter Ranges to Avoid Broken Geometry and Set Geometry for Initial Generation
jsol_ga_use_automatic_parameters_in_range_optimization	Flag	Set Parameters Automatically
jsol_ga_expand_range_search	Flag	Expand Search Range for Variables that Have Reached Minimum or Maximum in Variable Range
jsol_ga_max_generation_in_range_optimization	Flag	Number of Generations for Geometry Evaluation
jsol_ga_num_population_in_range_optimization	Flag	Population Size for Geometry Evaluation
jsol_ga_num_training_dataset_in_feasible_geometry_generation	Flag	Training Data Set Size for Geometry Surrogate Model
jsol_ga_shape_evalution	Flag	Continuous Shape Evaluation
jsol_ga_result_evaluation	Flag	Results Evaluation
jsol_ga_evalution_case	Flag	Number of Cases for Results Evaluation
jsol_ga_use_restart	Flag	Restart from Specified Generation
jsol_ga_use_automatic_parameters_in_optimization_engine	Flag	Set Optimization Engine Parameters automatically
jsol_ga_auto_seed	Flag	Generate Pseudo Random Number Seed Automatically
jsol_ga_seed_value	Flag	Seed Value

Multi-Objective Genetic Algorithm

Select the Optimization engine
app.GetModel(0).GetStudy(0).GetOptimizationTable().SetParameter("engine", "jsol_moga")

key list

key	Type	Description
jsol_moga_max_generation	Flag	Maximum Number of Generations
jsol_moga_num_population	Flag	Population Size
jsol_moga_group_cases	Flag	Group Cases by Generation
jsol_moga_group_prefix	String	Prefix
jsol_moga_error_handling	Flag	Apply Penalty to Error Cases
jsol_moga_omit_unnecessary_cases	Flag	Do Not Add Unnecessary Cases Due to Geometry or Constraint Errors
jsol_moga_use_range_optimization	Flag	Update CAD Parameter Ranges to Avoid Broken Geometry and Set Geometry for Initial Generation
jsol_moga_use_automatic_parameters_in_range_optimization	Flag	Set Parameters Automatically
jsol_moga_expand_range_search	Flag	Expand Search Range for Variables that Have Reached Minimum or Maximum in Variable Range
jsol_moga_max_generation_in_range_optimization	Flag	Number of Generations for Geometry Evaluation
jsol_moga_num_population_in_range_optimization	Flag	Population Size for Geometry Evaluation
jsol_moga_num_training_dataset_in_feasible_geometry_generation	Flag	Training Data Set Size for Geometry Surrogate Model
jsol_moga_shape_evalution	Flag	Continuous Shape Evaluation
jsol_moga_result_evaluation	Flag	Results Evaluation
jsol_moga_use_restart	Flag	Restart from Specified Generation
jsol_moga_use_automatic_parameters_in_optimization_engine	Flag	Set Optimization Engine Parameters automatically
jsol_moga_crossover_probability	Double	Crossover Probability
jsol_moga_crossover_eta	Double	Crossover Distribution Index
jsol_moga_mutation_probability	Double	Mutation Probability
jsol_moga_mutation_eta	Double	Mutation Distribution Index
jsol_moga_constraint_handling	Flag	Constraint Handling
jsol_moga_auto_seed	Flag	Generate Pseudo Random Number Seed Automatically
jsol_moga_seed_value	Flag	Seed Value

Genetic Algorithm (Topology)

Select the Optimization engine
app.GetModel(0).GetStudy(0).GetOptimizationTable().SetParameter("engine", "jsol_ga")

key list

key	Type	Description
jsol_ga_max_generation	Flag	Maximum Number of Generations
jsol_ga_num_population	Flag	Population Size
jsol_ga_num_children	Flag	Number of Children
jsol_ga_shape_evalution	Flag	Continuous Shape Evaluation
jsol_ga_result_evaluation	Flag	Results Evaluation
jsol_ga_evalution_case	Flag	Number of Cases for Results Evaluation
jsol_ga_use_restart	Flag	Restart from Specified Generation

Multi-Objective Genetic Algorithm (Topology, used until V.20.0)

Select the Optimization engine
app.GetModel(0).GetStudy(0).GetOptimizationTable().SetParameter("engine", "jsol_moga")

key list

key	Type	Description
jsol_moga_max_generation	Flag	Maximum Number of Generations
jsol_moga_num_population	Flag	Population Size
jsol_moga_num_children	Flag	Number of Children
jsol_moga_shape_evalution	Flag	Continuous Shape Evaluation
jsol_moga_result_evaluation	Flag	Results Evaluation
jsol_moga_use_restart	Flag	Restart from Specified Generation

Multi-Objective Genetic Algorithm (Topology)

Select the Optimization engine
app.GetModel(0).GetStudy(0).GetOptimizationTable().SetParameter("engine", "jsol_moga2")

key list

key	Type	Description
jsol_moga2_max_generation	Flag	Maximum Number of Generations
jsol_moga2_num_population	Flag	Population Size
jsol_moga2_num_children	Flag	Number of Children
jsol_moga2_shape_evalution	Flag	Continuous Shape Evaluation
jsol_moga2_result_evaluation	Flag	Results Evaluation
jsol_moga2_use_restart	Flag	Restart from Specified Generation

Genetic Algorithm (Surrogate Model)

Select the Optimization engine
app.GetModel(0).GetStudy(0).GetOptimizationTable().SetParameter("engine", "jsol_ga_surrogate")

key list

key	Type	Description
jsol_ga_surrogate_max_generation	Flag	Maximum Number of Generations
jsol_ga_surrogate_num_population	Flag	Population Size
jsol_ga_surrogate_num_children	Flag	Number of Children
jsol_ga_surrogate_step_size	Flag	Step-Size Parameter
jsol_ga_surrogate_stall_generation	Double	Stopping Criteria
jsol_ga_surrogate_group_cases	Flag	Group Cases by Generation
jsol_ga_surrogate_group_prefix	String	Prefix
jsol_ga_surrogate_error_handling	Flag	Apply Penalty to Error Cases
jsol_ga_surrogate_omit_unnecessary_cases	Flag	Do Not Add Unnecessary Cases Due to Geometry or Constraint Errors
jsol_ga_surrogate_use_range_optimization	Flag	Update CAD Parameter Ranges to Avoid Broken Geometry and Set Geometry for Initial Generation
jsol_ga_surrogate_use_automatic_parameters_in_range_optimization	Flag	Set Parameters Automatically
jsol_ga_surrogate_expand_range_search	Flag	Expand Search Range for Variables that Have Reached Minimum or Maximum in Variable Range
jsol_ga_surrogate_max_generation_in_range_optimization	Flag	Number of Generations for Geometry Evaluation
jsol_ga_surrogate_num_population_in_range_optimization	Flag	Population Size for Geometry Evaluation
jsol_ga_surrogate_num_training_dataset_in_feasible_geometry_generation	Flag	Training Data Set Size for Geometry Surrogate Model
jsol_ga_surrogate_calc_fea_skipmode	Flag	FEA execution interval specification mode
jsol_ga_surrogate_calc_fea_interval	Flag	FEA execution interval
jsol_ga_surrogate_calc_fea_skip_range	String	FEA skip generation
jsol_ga_surrogate_surrogate_model_output_file_path	String	Output path of the surrogate model file
jsol_ga_surrogate_output_surrogate_model_files_of_all_generations	Flag	Output jml files for all generations
jsol_ga_surrogate_use_automatic_parameters_in_optimization_engine	Flag	Set Optimization Engine Parameters automatically
jsol_ga_surrogate_auto_seed	Flag	Generate Pseudo Random Number Seed Automatically
jsol_ga_surrogate_seed_value	Flag	Seed Value

Multi-Objective Genetic Algorithm (Surrogate Model)

Select the Optimization engine
app.GetModel(0).GetStudy(0).GetOptimizationTable().SetParameter("engine", "jsol_moga_surrogate")

key list

key	Type	Description
jsol_moga_surrogate_max_generation	Flag	Maximum Number of Generations
jsol_moga_surrogate_num_population	Flag	Population Size
jsol_moga_surrogate_group_cases	Flag	Group Cases by Generation
jsol_moga_surrogate_group_prefix	String	Prefix
jsol_moga_surrogate_error_handling	Flag	Apply Penalty to Error Cases
jsol_moga_surrogate_omit_unnecessary_cases	Flag	Do Not Add Unnecessary Cases Due to Geometry or Constraint Errors
jsol_moga_surrogate_use_range_optimization	Flag	Update CAD Parameter Ranges to Avoid Broken Geometry and Set Geometry for Initial Generation
jsol_moga_surrogate_use_automatic_parameters_in_range_optimization	Flag	Set Parameters Automatically
jsol_moga_surrogate_expand_range_search	Flag	Expand Search Range for Variables that Have Reached Minimum or Maximum in Variable Range
jsol_moga_surrogate_max_generation_in_range_optimization	Flag	Number of Generations for Geometry Evaluation
jsol_moga_surrogate_num_population_in_range_optimization	Flag	Population Size for Geometry Evaluation
jsol_moga_surrogate_num_training_dataset_in_feasible_geometry_generation	Flag	Training Data Set Size for Geometry Surrogate Model
jsol_moga_surrogate_calc_fea_skipmode	Flag	FEA execution interval specification mode
jsol_moga_surrogate_calc_fea_interval	Flag	FEA execution interval
jsol_moga_surrogate_calc_fea_skip_range	String	FEA skip generation
jsol_moga_surrogate_use_restart	Flag	Restart from Specified Generation
jsol_moga_surrogate_surrogate_model_type	Flag	Surrogate Model to Use
jsol_moga_surrogate_connected_layers	Flag	Fully Connected Layers
jsol_moga_surrogate_first_layer_size	Flag	First Layer Size
jsol_moga_surrogate_second_layer_size	Flag	Second Layer Size
jsol_moga_surrogate_third_layer_size	Flag	Third Layer Size
jsol_moga_surrogate_learning_rate	Double	Learning Rate
jsol_moga_surrogate_regularization_strength	Double	Regularization Strength
jsol_moga_surrogate_max_epochs	Flag	Maximum Number of Epochs
jsol_moga_surrogate_surrogate_parallel_cores	Flag	Cores to Use (Parallel Computing for Creating Surrogate Model)
jsol_moga_surrogate_surrogate_model_output_file_path	String	Output path of the surrogate model file
jsol_moga_surrogate_output_surrogate_model_files_of_all_generations	Flag	Output jml files for all generations
jsol_moga_surrogate_use_automatic_parameters_in_optimization_engine	Flag	Set Optimization Engine Parameters automatically
jsol_moga_surrogate_crossover_probability	Double	Crossover Probability
jsol_moga_surrogate_crossover_eta	Double	Crossover Distribution Index
jsol_moga_surrogate_mutation_probability	Double	Mutation Probability
jsol_moga_surrogate_mutation_eta	Double	Mutation Distribution Index
jsol_moga_surrogate_auto_seed	Flag	Generate Pseudo Random Number Seed Automatically
jsol_moga_surrogate_seed_value	Flag	Seed Value

Multi-Objective Genetic Algorithm (Surrogate Model Automatic Generation)

Select the Optimization engine
app.GetModel(0).GetStudy(0).GetOptimizationTable().SetParameter("engine", "jsol_moga_surrogate_auto_generation")

key list

key	Type	Description
jsol_moga_surrogate_auto_generation_max_generation	Flag	FEA Execution Generations
jsol_moga_surrogate_auto_generation_num_population	Flag	Population Size
jsol_moga_surrogate_auto_generation_group_cases	Flag	Group Cases by Generation
jsol_moga_surrogate_auto_generation_group_prefix	String	Prefix
jsol_moga_surrogate_auto_generation_error_handling	Flag	Apply Penalty to Error Cases
jsol_moga_surrogate_auto_generation_omit_unnecessary_cases	Flag	Do Not Add Unnecessary Cases Due to Geometry or Constraint Errors
jsol_moga_surrogate_auto_generation_use_range_optimization	Flag	Update CAD Parameter Ranges to Avoid Broken Geometry and Set Geometry for Initial Generation
jsol_moga_surrogate_auto_generation_use_automatic_parameters_in_range_optimization	Flag	Set Parameters Automatically
jsol_moga_surrogate_auto_generation_expand_range_search	Flag	Expand Search Range for Variables that Have Reached Minimum or Maximum in Variable Range
jsol_moga_surrogate_auto_generation_max_generation_in_range_optimization	Flag	Number of Generations for Geometry Evaluation
jsol_moga_surrogate_auto_generation_num_population_in_range_optimization	Flag	Population Size for Geometry Evaluation
jsol_moga_surrogate_auto_generation_num_training_dataset_in_feasible_geometry_generation	Flag	Training Data Set Size for Geometry Surrogate Model
jsol_moga_surrogate_auto_generation_use_restart	Flag	Restart from Specified Generation
jsol_moga_surrogate_auto_generation_surrogate_model_type	Flag	Surrogate Model to Use
jsol_moga_surrogate_auto_generation_connected_layers	Flag	Fully Connected Layers
jsol_moga_surrogate_auto_generation_first_layer_size	Flag	First Layer Size
jsol_moga_surrogate_auto_generation_second_layer_size	Flag	Second Layer Size
jsol_moga_surrogate_auto_generation_third_layer_size	Flag	Third Layer Size
jsol_moga_surrogate_auto_generation_learning_rate	Double	Learning Rate
jsol_moga_surrogate_auto_generation_regularization_strength	Double	Regularization Strength
jsol_moga_surrogate_auto_generation_max_epochs	Flag	Maximum Number of Epochs
jsol_moga_surrogate_auto_generation_surrogate_parallel_cores	Flag	Cores to Use (Parallel Computing for Creating Surrogate Model)
jsol_moga_surrogate_auto_generation_surrogate_model_output_file_path	String	Output path of the surrogate model file
jsol_moga_surrogate_auto_generation_output_surrogate_model_files_of_all_generations	Flag	Output jml files for all generations
jsol_moga_surrogate_auto_generation_use_automatic_parameters_in_optimization_engine	Flag	Set Optimization Engine Parameters automatically
jsol_moga_surrogate_auto_generation_crossover_probability	Double	Crossover Probability
jsol_moga_surrogate_auto_generation_crossover_eta	Double	Crossover Distribution Index
jsol_moga_surrogate_auto_generation_mutation_probability	Double	Mutation Probability
jsol_moga_surrogate_auto_generation_mutation_eta	Double	Mutation Distribution Index
jsol_moga_surrogate_auto_generation_auto_seed	Flag	Generate Pseudo Random Number Seed Automatically
jsol_moga_surrogate_auto_generation_seed_value	Flag	Seed Value

value Parameter value

void OptimizationTable::SetPBSQueue ( String & pbsQueue )

Specifies PBS queue.

Parameters

pbsQueue PBS queue

void OptimizationTable::SetPBSResource ( String & pbsResource )

Specifies PBS resource.

Parameters

pbsResource PBS resource

void OptimizationTable::SetPreProcessOnWrite ( bool need )

Specifies whether to pre process to submit jcf.

Parameters

need	Whether to pre process to submit jcf

void OptimizationTable::SetRangeStringList	(	Variant &	indexOrName,
		String &	parameter,
		StringList &	array
	)

Set the range table string values for optimization.

Parameters

indexOrName	Parametric Item Name
parameter	Value Name
array	String Table

void OptimizationTable::SetRangeValue	(	Variant &	indexOrName,
		String &	parameter,
		Variant &	value
	)

Set the range values for optimization.

Parameters

indexOrName	Parametric Item Name
parameter	Value Name
value	Value

void OptimizationTable::SetRangeValueList	(	Variant &	indexOrName,
		String &	parameter,
		String array &	array
	)

Set the range table values for optimization.

Parameters

indexOrName	Parametric Item Name
parameter	Value Name
array	Table Values

void OptimizationTable::SetReservationKey ( String & key )

Specifies the license reservation key for the calculation.

Parameters

key	The dynamic reservation key

void OptimizationTable::SetRestartDataFromFile ( String & filePath )

Specifies the restart data from the restart data file.

Parameters

filePath Restart file

void OptimizationTable::SetRestartFileOutputPath ( String & filePath )

Specifies the restart file to resume optimization from last iteration.

Parameters

filePath Restart file

void OptimizationTable::SetResubmitCpuGroup ( String & group )

Specifies the CPU group for resubmitted calculations.

Parameters

group CPU group

void OptimizationTable::SetResubmitMachine ( String & machine )

Specifies the machine name to resubmit calculations to.

Parameters

machine Machine name

void OptimizationTable::SetRunAsProject ( bool asProject )

Specifies whether or not to send a project file.

Parameters

asProject Whether or not to send a project file

void OptimizationTable::SetSendSSHSettings ( bool sendSettings )

Specifies whether to send SSH Settings to remote machine.

Parameters

sendSettings Send SSH Settings to remote machine

void OptimizationTable::SetSimultaneousStudies ( int value )

Specifies the number of studies to be executed concurrently when executing the foreground calculation.

Parameters

value Simultaneous Number of Studies

void OptimizationTable::SetSlurmOptions ( String & slurmOptions )

Specifies Slurm options.

Parameters

slurmOptions Slurm options

void OptimizationTable::SetStopOnFailedCase ( bool stop )

Specifies whether or not to stop the calculation when an error occurs.

Parameters

stop	Whether or not to stop the calculation

void OptimizationTable::SetTolerance ( double tolerance )

Obsolete function.

Deprecated:

void OptimizationTable::SetUseJobSystem ( bool useJobSystem )

Specifies whether to use JMAG Job system.

Parameters

useJobSystem Use JMAG Job system

void OptimizationTable::SetUseJobSystemTimeout ( bool useTimeout )

Specifies whether to use timeout of analysis job.

Parameters

useTimeout Use JMAG Job system

void OptimizationTable::SetUseLicenseControl ( bool useLicenseControl )

Specifies whether to use License Control.

Parameters

useLicenseControl Use License Control

void OptimizationTable::SetUseLocalCalculationFolder ( bool use )

Specifies whether or not to batch execution with local calculation folder.

Parameters

use	Whether or not to use local calculation folder

void OptimizationTable::SetUseMultiLicense ( bool useMulti )

Specifies if the calculation should use the LM-X multi-calculation license.

Parameters

useMulti Boolean flag, True is use multi-license

String OptimizationTable::SlurmOptions ( )

Returns the Slurm options.

Returns: Slurm options

bool OptimizationTable::StopOnFailedCase ( )

Specifies whether or not to stop a calculation when running a calculation.

Returns: Whether or not to stop a calculation

void OptimizationTable::Tolerance ( )

Obsolete function.

Deprecated:

bool OptimizationTable::UseJobSystem ( )

Returns whether or not to use JMAG job system.

Returns: Whether or not to use JMAG job system

bool OptimizationTable::UseJobSystemTimeout ( )

Returns whether to use timeout of analysis job.

Returns: Whether or not to use timeout of analysis job.

bool OptimizationTable::UseLicenseControl ( )

Returns whether or not to use license control.

Returns: Whether or not to use license control

void OptimizationTable::UseLocalCalculationFolder ( )

Specifies whether or not to batch execution with local calculation folder.

Parameters

use	Whether or not to use local calculation folder

Public Member Functions

Detailed Description

Member Function Documentation