/Users/economon/SU2/trunk/SU2_CFD/include/definition_structure.hpp File Reference

Headers of the main subroutines used by SU2_CFD. The subroutines and functions are in the definition_structure.cpp file. More...

#include <ctime>
#include <mpi.h>
#include "solution_structure.hpp"
#include "integration_structure.hpp"
#include "output_structure.hpp"
#include "numerics_structure.hpp"
#include "../../Common/include/geometry_structure.hpp"
#include "../../Common/include/config_structure.hpp"

Go to the source code of this file.

Functions
unsigned short	GetnZone (string val_mesh_filename, unsigned short val_format, CConfig *config)
	Gets the number of zones in the mesh file.
unsigned short	GetnDim (string val_mesh_filename, unsigned short val_format)
	Gets the number of dimensions in the mesh file.
void	Solution_Definition (CSolution ***solution_container, CGeometry **geometry, CConfig *config, unsigned short iZone)
	Definition and allocation of all solution classes.
void	Integration_Definition (CIntegration **integration_container, CGeometry **geometry, CConfig *config, unsigned short iZone)
	Definition and allocation of all integration classes.
void	Solver_Definition (CNumerics ****solver_container, CSolution ***solution_container, CGeometry **geometry, CConfig *config, unsigned short iZone)
	Definition and allocation of all solver classes.
void	Geometrical_Definition (CGeometry ***geometry, CConfig **config, unsigned short val_nZone)
	Do the geometrical preprocessing.
void	Solver_Deallocation (CNumerics ****solver_container, CSolution ***solution_container, CIntegration **integration_container, COutput *output, CGeometry **geometry, CConfig *config, unsigned short iZone)
	Deallocation of the pointers solver_container, solution_container, integration_container, geometry, output, config.
void	Geometrical_Deallocation (CGeometry **geometry, CConfig *config)
	Deallocation of the pointers geometry.

---

Detailed Description

Headers of the main subroutines used by SU2_CFD. The subroutines and functions are in the definition_structure.cpp file.

Author:

Aerospace Design Laboratory (Stanford University) <http://su2.stanford.edu>.

Version:

2.0.

Stanford University Unstructured (SU2) Code Copyright (C) 2012 Aerospace Design Laboratory

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

---

Function Documentation

void Geometrical_Deallocation	(	CGeometry **	geometry,
		CConfig *	config
	)

Deallocation of the pointers geometry.

Parameters:

[in]	geometry	- Geometrical definition of the problem.
[in]	config	- Definition of the particular problem.

void Geometrical_Definition	(	CGeometry ***	geometry,
		CConfig **	config,
		unsigned short	val_nZone
	)

Do the geometrical preprocessing.

Parameters:

[in]	geometry	- Geometrical definition of the problem.
[in]	config	- Definition of the particular problem.
[in]	val_nZone	- Total number of zones.

unsigned short GetnDim	(	string	val_mesh_filename,
		unsigned short	val_format
	)

Gets the number of dimensions in the mesh file.

Parameters:

[in]	val_mesh_filename	- Name of the file with the grid information.
[in]	val_format	- Format of the file with the grid information.

Returns:

Total number of domains in the grid file.

unsigned short GetnZone	(	string	val_mesh_filename,
		unsigned short	val_format,
		CConfig *	config
	)

Gets the number of zones in the mesh file.

Author:

T. Economon

Parameters:

[in]	val_mesh_filename	- Name of the file with the grid information.
[in]	val_format	- Format of the file with the grid information.
[in]	config	- Definition of the particular problem.

Returns:

Total number of zones in the grid file.

void Integration_Definition	(	CIntegration **	integration_container,
		CGeometry **	geometry,
		CConfig *	config,
		unsigned short	iZone
	)

Definition and allocation of all integration classes.

Parameters:

[in]	integration_container	- Container vector with all the integration methods.
[in]	geometry	- Geometrical definition of the problem.
[in]	config	- Definition of the particular problem.
[in]	iZone	- Index of the zone.

void Solution_Definition	(	CSolution ***	solution_container,
		CGeometry **	geometry,
		CConfig *	config,
		unsigned short	iZone
	)

Definition and allocation of all solution classes.

Parameters:

[in]	solution_container	- Container vector with all the solutions.
[in]	geometry	- Geometrical definition of the problem.
[in]	config	- Definition of the particular problem.
[in]	iZone	- Index of the zone.

void Solver_Deallocation	(	CNumerics ****	solver_container,
		CSolution ***	solution_container,
		CIntegration **	integration_container,
		COutput *	output,
		CGeometry **	geometry,
		CConfig *	config,
		unsigned short	iZone
	)

Deallocation of the pointers solver_container, solution_container, integration_container, geometry, output, config.

Parameters:

[in]	solver_container	- Description of the numerical method (the way in which the equations are solved).
[in]	solution_container	- Container vector with all the solutions.
[in]	integration_container	- Container vector with all the integration methods.
[in]	output	- Pointer to the COutput class.
[in]	geometry	- Geometrical definition of the problem.
[in]	config	- Definition of the particular problem.
[in]	iZone	- Index of the zone.

void Solver_Definition	(	CNumerics ****	solver_container,
		CSolution ***	solution_container,
		CGeometry **	geometry,
		CConfig *	config,
		unsigned short	iZone
	)

Definition and allocation of all solver classes.

Parameters:

[in]	solver_container	- Description of the numerical method (the way in which the equations are solved).
[in]	solution_container	- Container vector with all the solutions.
[in]	geometry	- Geometrical definition of the problem.
[in]	config	- Definition of the particular problem.
[in]	iZone	- Index of the zone.