kim_model_write_parameterized_model_module Module Reference

Provides the interface to a KIM API Model object for use by models within their MODEL_ROUTINE_NAME::WriteParameterizedModel routine. More...

Functions/Subroutines
recursive subroutine	kim_model_write_parameterized_model_get_model_name (model_write_parameterized_model_handle, model_name)
	Get the name of the new parameterized model. More...
recursive subroutine	kim_model_write_parameterized_model_set_parameter_file_name (model_write_parameterized_model_handle, file_name)
	Set the file name for the next parameter file. More...
recursive subroutine	kim_model_write_parameterized_model_get_model_buffer_pointer (model_write_parameterized_model_handle, ptr)
	Get the Model's buffer pointer within the Model object. More...
recursive subroutine	kim_model_write_parameterized_model_log_entry (model_write_parameterized_model_handle, log_verbosity, message)
	Write a log entry into the log file. More...
recursive subroutine	kim_model_write_parameterized_model_to_string (model_write_parameterized_model_handle, string)
	Get a string representing the internal state of the Model object. More...

Variables
type(kim_model_write_parameterized_model_handle_type), save, public, protected	kim_model_write_parameterized_model_null_handle
	NULL handle for use in comparisons. More...

Detailed Description

Provides the interface to a KIM API Model object for use by models within their MODEL_ROUTINE_NAME::WriteParameterizedModel routine.

See also

KIM::ModelWriteParameterizedModel, KIM_ModelWriteParameterizedModel

Since

2.0

Function/Subroutine Documentation

kim_model_write_parameterized_model_get_model_buffer_pointer()

recursive subroutine kim_model_write_parameterized_model_module::kim_model_write_parameterized_model_get_model_buffer_pointer	(	type(kim_model_write_parameterized_model_handle_type), intent(in)	model_write_parameterized_model_handle,
		type(c_ptr), intent(out)	ptr
	)

Get the Model's buffer pointer within the Model object.

See also

KIM::ModelWriteParameterizedModel::GetModelBufferPointer, KIM_ModelWriteParameterizedModel_GetModelBufferPointer

Since

2.0

Definition at line 302 of file kim_model_write_parameterized_model_module.f90.

kim_model_write_parameterized_model_get_model_name()

recursive subroutine kim_model_write_parameterized_model_module::kim_model_write_parameterized_model_get_model_name	(	type(kim_model_write_parameterized_model_handle_type), intent(in)	model_write_parameterized_model_handle,
		character(len=*, kind=c_char), intent(out)	model_name
	)

Get the name of the new parameterized model.

See also

KIM::ModelWriteParameterizedModel::GetModelName, KIM_ModelWriteParameterizedModel_GetModelName

Since

2.0

Definition at line 225 of file kim_model_write_parameterized_model_module.f90.

kim_model_write_parameterized_model_log_entry()

recursive subroutine kim_model_write_parameterized_model_module::kim_model_write_parameterized_model_log_entry	(	type(kim_model_write_parameterized_model_handle_type), intent(in)	model_write_parameterized_model_handle,
		type(kim_log_verbosity_type), intent(in)	log_verbosity,
		character(len=*, kind=c_char), intent(in)	message
	)

Write a log entry into the log file.

See also

KIM::ModelWriteParameterizedModel::LogEntry, KIM_ModelWriteParameterizedModel_LogEntry

Since

2.0

Definition at line 337 of file kim_model_write_parameterized_model_module.f90.

kim_model_write_parameterized_model_set_parameter_file_name()

recursive subroutine kim_model_write_parameterized_model_module::kim_model_write_parameterized_model_set_parameter_file_name	(	type(kim_model_write_parameterized_model_handle_type), intent(in)	model_write_parameterized_model_handle,
		character(len=*, kind=c_char), intent(in)	file_name
	)

Set the file name for the next parameter file.

See also

KIM::ModelWriteParameterizedModel::SetParameterFileName, KIM_ModelWriteParameterizedModel_SetParameterFileName

Since

2.0

Definition at line 265 of file kim_model_write_parameterized_model_module.f90.

kim_model_write_parameterized_model_to_string()

recursive subroutine kim_model_write_parameterized_model_module::kim_model_write_parameterized_model_to_string	(	type(kim_model_write_parameterized_model_handle_type), intent(in)	model_write_parameterized_model_handle,
		character(len=*, kind=c_char), intent(out)	string
	)

Get a string representing the internal state of the Model object.

See also

KIM::ModelWriteParameterizedModel::ToString, KIM_ModelWriteParameterizedModel_ToString

Since

2.0

Definition at line 379 of file kim_model_write_parameterized_model_module.f90.

Variable Documentation

kim_model_write_parameterized_model_null_handle

type(kim_model_write_parameterized_model_handle_type), save, public, protected kim_model_write_parameterized_model_module::kim_model_write_parameterized_model_null_handle

NULL handle for use in comparisons.

Since

2.0

Definition at line 67 of file kim_model_write_parameterized_model_module.f90.