read_csv_table_utility.ReadCsvTableUtility Class Reference

This class is used to retrieve a table from the specified parameters. More...

Collaboration diagram for read_csv_table_utility.ReadCsvTableUtility:

Public Member Functions
def	__init__ (self, settings)
	Constructor of the csv table reader: validate the parameters. More...
def	Read (self, model_part=None)
	Read a csv table. More...

Public Attributes
	filename
	delimiter
	skiprows
	first_column_id
	second_column_id
	table_id
	na_replace

Detailed Description

This class is used to retrieve a table from the specified parameters.

The following parameters can be specified:
|--------------------|------------------------------------------------------|
| "name"             | The type of input (csv_table)                        |
|--------------------|------------------------------------------------------|
| "filename"         | The file name                                        |
|--------------------|------------------------------------------------------|
| "delimiter"        | ","  comma                                           |
|                    | ";"  semicolon                                       |
|                    | "\t" tab                                             |
|                    | " "  spaces                                          |
|                    |      etc                                             |
|---------------- ---|------------------------------------------------------|
| "skiprows"         | The number of rows to skip before reading data       |
|--------------- ----|------------------------------------------------------|
| "first_column_id"  | The index of the first column to read (zero-based)   |
|----------------- --|------------------------------------------------------|
| "second_column_id" | The index of the second column to read (zero-based)  |
|--------------------|------------------------------------------------------|
| "table_id"         | If >-1 the input table will be stored in the         |
|                    | model part                                           |
|--------------------|------------------------------------------------------|
| "na_replace"       | The value to apply when N/A is read                  |
|--------------------|------------------------------------------------------|

Constructor & Destructor Documentation

__init__()

def read_csv_table_utility.ReadCsvTableUtility.__init__	(		self,
			settings
	)

Constructor of the csv table reader: validate the parameters.

    Keyword arguments:
    self -- It signifies an instance of the class.
    settings -- Kratos parameters containing solver settings.

Member Function Documentation

Read()

def read_csv_table_utility.ReadCsvTableUtility.Read	(		self,
			model_part = None
	)

Read a csv table.

    Keyword arguments:
    self -- It signifies an instance of the class.
    model_part -- ModelPart where to store or apply the table.

Member Data Documentation

delimiter

read_csv_table_utility.ReadCsvTableUtility.delimiter

filename

read_csv_table_utility.ReadCsvTableUtility.filename

first_column_id

read_csv_table_utility.ReadCsvTableUtility.first_column_id

na_replace

read_csv_table_utility.ReadCsvTableUtility.na_replace

second_column_id

read_csv_table_utility.ReadCsvTableUtility.second_column_id

skiprows

read_csv_table_utility.ReadCsvTableUtility.skiprows

table_id

read_csv_table_utility.ReadCsvTableUtility.table_id

---

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

• /home/runner/work/Documentation/Documentation/master/kratos/python_scripts/read_csv_table_utility.py