Use SF_CoSolver to start a Sinda run via an input text file and communicate with it. Implements the OpenTD.CoSolver.CoSolver Implements the OpenTD.CoSolver.ISF_RunConfig More...

Inheritance diagram for OpenTD.CoSolver.SF_CoSolver:

Public Member Functions
	SF_CoSolver (string inputFilePath)

	SF_CoSolver (string inputFilePath, string communicationsPipeId)

override void	Initialize ()

void	SetupExperiment ()

void	Abort ()

int	DoStep ()

int	Continue ()
	Tells Sinda to proceed to the next step of the simulation. Return values: -1 - Sinda disconnected or error 0 - Sinda initial connection after call to OPENSF 99 - Sinda termination.

string	GetRegisterExpression (string name)

double	GetRegisterValue (string name)

void	SetRegisterExpression (string name, double value)

double	GetValue (string submodel, int Id, string type)

double	GetValue (int SequenceNumber, string type)

double	GetValue (string name)

Int64	GetNodeSequenceNumber (string submodel, int Id)

Int64	GetPathSequenceNumber (string submodel, int Id)

Int64	GetCondSequenceNumber (string submodel, int Id)

Int64	GetTieSequenceNumber (string submodel, int Id)

Int64	GetLumpSequenceNumber (string submodel, int Id)

void	Set_Q_UDFA (string name, int SequenceNumber, double value)

void	SetValue (string submodel, int Id, string type, double value)

void	SetValue (int SequenceNumber, string type, double value)

void	SetValue (string name, double value)

Protected Member Functions
void	CreateSF_Pipe ()

void	CloseSF_Pipe ()

Protected Attributes
string	pipeID

SF_Pipe	sf_pipe = null

Properties
Process	SindaFluintProcess `[get]`
	After calling Initalize(), use SindaFluintProcess to access the operating system process running Sinda.

string	SindaExePathname `[get, set]`
	By default, Run() will use the most-recent version of sinda.exe installed on your system. To force it to use a specific version, set SindaExePathname to the path to the sinda.exe you'd like to use. Relative paths are evaluated from the client program working directory.

string	InputPathname `[get, set]`
	The Sinda input deck to run. Relative pathnames are evaluated from the client program working directory.

string	PreprocessorOutputPathname `[get, set]`
	Preprocessor output pathname. Defaults to 'pp.out'. Relative pathnames are evaluated from the InputPathname directory.

bool	Cleanup `[get, set]`
	If true, Sinda will delete any temporary directories when finished. Defaults to true.

bool	LicenseWait `[get, set]`

bool	StatusWindows `[get, set]`
	If true, Sinda shows status windows during the run. Defaults to false;.

bool	UseOpenMP `[get, set]`

string	AdditionalCompileOptions `[get, set]`
	Add additional commandline switches for the compiler here. Example: '/warn:declarations'.

string	AdditionalLinkOptions `[get, set]`
	Add additional commandline switches for the linker here. Example: 'MyAddOnLibrary.lib'.

int	InitializeTimeoutMs = 60000 `[get, set]`
	Determines how long in milliseconds that Initialize() will try to connect to the Sinda run.

double	CouplingTimeStep `[set]`

bool	Converged `[set]`

Detailed Description

Use SF_CoSolver to start a Sinda run via an input text file and communicate with it. Implements the OpenTD.CoSolver.CoSolver Implements the OpenTD.CoSolver.ISF_RunConfig

See also: OpenTD.CoSolver.CoSolver, OpenTD.CoSolver.ISF_RunConfig

Constructor & Destructor Documentation

◆ SF_CoSolver() [1/2]

OpenTD.CoSolver.SF_CoSolver.SF_CoSolver ( string inputFilePath )

inline

◆ SF_CoSolver() [2/2]

OpenTD.CoSolver.SF_CoSolver.SF_CoSolver	(	string	inputFilePath,
		string	communicationsPipeId )

inline

Member Function Documentation

◆ Abort()

void OpenTD.CoSolver.CoSolver.Abort ( )

inlineinherited

◆ CloseSF_Pipe()

void OpenTD.CoSolver.CoSolver.CloseSF_Pipe ( )

inlineprotectedinherited

◆ Continue()

int OpenTD.CoSolver.CoSolver.Continue ( )

inlineinherited

Tells Sinda to proceed to the next step of the simulation. Return values: -1 - Sinda disconnected or error 0 - Sinda initial connection after call to OPENSF 99 - Sinda termination.

11 - beginning of STEADY 12 - end of STEADY

1 - beginning of TRANSIENT 2 - at end of TRANSIENT time step 3 - at end of TRANSIENT

◆ CreateSF_Pipe()

void OpenTD.CoSolver.CoSolver.CreateSF_Pipe ( )

inlineprotectedinherited

◆ DoStep()

int OpenTD.CoSolver.CoSolver.DoStep ( )

inlineinherited

◆ GetCondSequenceNumber()

Int64 OpenTD.CoSolver.CoSolver.GetCondSequenceNumber	(	string	submodel,
		int	Id )

inlineinherited

◆ GetLumpSequenceNumber()

Int64 OpenTD.CoSolver.CoSolver.GetLumpSequenceNumber	(	string	submodel,
		int	Id )

inlineinherited

◆ GetNodeSequenceNumber()

Int64 OpenTD.CoSolver.CoSolver.GetNodeSequenceNumber	(	string	submodel,
		int	Id )

inlineinherited

◆ GetPathSequenceNumber()

Int64 OpenTD.CoSolver.CoSolver.GetPathSequenceNumber	(	string	submodel,
		int	Id )

inlineinherited

◆ GetRegisterExpression()

string OpenTD.CoSolver.CoSolver.GetRegisterExpression ( string name )

inlineinherited

◆ GetRegisterValue()

double OpenTD.CoSolver.CoSolver.GetRegisterValue ( string name )

inlineinherited

◆ GetTieSequenceNumber()

Int64 OpenTD.CoSolver.CoSolver.GetTieSequenceNumber	(	string	submodel,
		int	Id )

inlineinherited

◆ GetValue() [1/3]

double OpenTD.CoSolver.CoSolver.GetValue	(	int	SequenceNumber,
		string	type )

inlineinherited

◆ GetValue() [2/3]

double OpenTD.CoSolver.CoSolver.GetValue ( string name )

inlineinherited

◆ GetValue() [3/3]

double OpenTD.CoSolver.CoSolver.GetValue	(	string	submodel,
		int	Id,
		string	type )

inlineinherited

◆ Initialize()

override void OpenTD.CoSolver.SF_CoSolver.Initialize ( )

inlinevirtual

Reimplemented from OpenTD.CoSolver.CoSolver.

◆ Set_Q_UDFA()

void OpenTD.CoSolver.CoSolver.Set_Q_UDFA	(	string	name,
		int	SequenceNumber,
		double	value )

inlineinherited

◆ SetRegisterExpression()

void OpenTD.CoSolver.CoSolver.SetRegisterExpression	(	string	name,
		double	value )

inlineinherited

◆ SetupExperiment()

void OpenTD.CoSolver.CoSolver.SetupExperiment ( )

inlineinherited

◆ SetValue() [1/3]

void OpenTD.CoSolver.CoSolver.SetValue	(	int	SequenceNumber,
		string	type,
		double	value )

inlineinherited

◆ SetValue() [2/3]

void OpenTD.CoSolver.CoSolver.SetValue	(	string	name,
		double	value )

inlineinherited

◆ SetValue() [3/3]

void OpenTD.CoSolver.CoSolver.SetValue	(	string	submodel,
		int	Id,
		string	type,
		double	value )

inlineinherited

Member Data Documentation

◆ pipeID

string OpenTD.CoSolver.CoSolver.pipeID

protectedinherited

◆ sf_pipe

SF_Pipe OpenTD.CoSolver.CoSolver.sf_pipe = null

protectedinherited

Property Documentation

◆ AdditionalCompileOptions

string OpenTD.CoSolver.SF_CoSolver.AdditionalCompileOptions

getset

Add additional commandline switches for the compiler here. Example: '/warn:declarations'.

Implements OpenTD.CoSolver.ISF_RunConfig.

◆ AdditionalLinkOptions

string OpenTD.CoSolver.SF_CoSolver.AdditionalLinkOptions

getset

Add additional commandline switches for the linker here. Example: 'MyAddOnLibrary.lib'.

Implements OpenTD.CoSolver.ISF_RunConfig.

◆ Cleanup

bool OpenTD.CoSolver.SF_CoSolver.Cleanup

getset

If true, Sinda will delete any temporary directories when finished. Defaults to true.

Implements OpenTD.CoSolver.ISF_RunConfig.

◆ Converged

bool OpenTD.CoSolver.CoSolver.Converged

setinherited

◆ CouplingTimeStep

double OpenTD.CoSolver.CoSolver.CouplingTimeStep

setinherited

◆ InitializeTimeoutMs

int OpenTD.CoSolver.CoSolver.InitializeTimeoutMs = 60000

getsetinherited

Determines how long in milliseconds that Initialize() will try to connect to the Sinda run.

◆ InputPathname

string OpenTD.CoSolver.SF_CoSolver.InputPathname

getset

The Sinda input deck to run. Relative pathnames are evaluated from the client program working directory.

Implements OpenTD.CoSolver.ISF_RunConfig.

◆ LicenseWait

bool OpenTD.CoSolver.SF_CoSolver.LicenseWait

getset

Implements OpenTD.CoSolver.ISF_RunConfig.

◆ PreprocessorOutputPathname

string OpenTD.CoSolver.SF_CoSolver.PreprocessorOutputPathname

getset

Preprocessor output pathname. Defaults to 'pp.out'. Relative pathnames are evaluated from the InputPathname directory.

Implements OpenTD.CoSolver.ISF_RunConfig.

◆ SindaExePathname

string OpenTD.CoSolver.SF_CoSolver.SindaExePathname

getset

By default, Run() will use the most-recent version of sinda.exe installed on your system. To force it to use a specific version, set SindaExePathname to the path to the sinda.exe you'd like to use. Relative paths are evaluated from the client program working directory.

Implements OpenTD.CoSolver.ISF_RunConfig.

◆ SindaFluintProcess

Process OpenTD.CoSolver.SF_CoSolver.SindaFluintProcess

get

After calling Initalize(), use SindaFluintProcess to access the operating system process running Sinda.

◆ StatusWindows

bool OpenTD.CoSolver.SF_CoSolver.StatusWindows

getset

If true, Sinda shows status windows during the run. Defaults to false;.

Implements OpenTD.CoSolver.ISF_RunConfig.

◆ UseOpenMP

bool OpenTD.CoSolver.SF_CoSolver.UseOpenMP

getset

Implements OpenTD.CoSolver.ISF_RunConfig.

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

C:/Users/mgarrett/source/repos/BuildsTdSuite/builds/TDDEV_ALPHA/buildXX/OpenTD.CoSolver/SF_CoSolver.cs

OpenTD.CoSolver.SF_CoSolver Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ SF_CoSolver() [1/2]

◆ SF_CoSolver() [2/2]

Member Function Documentation

◆ Abort()

◆ CloseSF_Pipe()

◆ Continue()

◆ CreateSF_Pipe()

◆ DoStep()

◆ GetCondSequenceNumber()

◆ GetLumpSequenceNumber()

◆ GetNodeSequenceNumber()

◆ GetPathSequenceNumber()

◆ GetRegisterExpression()

◆ GetRegisterValue()

◆ GetTieSequenceNumber()

◆ GetValue() [1/3]

◆ GetValue() [2/3]

◆ GetValue() [3/3]

◆ Initialize()

◆ Set_Q_UDFA()

◆ SetRegisterExpression()

◆ SetupExperiment()

◆ SetValue() [1/3]

◆ SetValue() [2/3]

◆ SetValue() [3/3]

Member Data Documentation

◆ pipeID

◆ sf_pipe

Property Documentation

◆ AdditionalCompileOptions

◆ AdditionalLinkOptions

◆ Cleanup

◆ Converged

◆ CouplingTimeStep

◆ InitializeTimeoutMs

◆ InputPathname

◆ LicenseWait

◆ PreprocessorOutputPathname

◆ SindaExePathname

◆ SindaFluintProcess

◆ StatusWindows

◆ UseOpenMP

Connect with Ansys