Functions/Subroutines
program	__m_patches_fpp_f90__

subroutine	s_line_segment (patch_id, patch_id_fp, q_prim_vf)
	The line segment patch is a 1D geometry that may be used, for example, in creating a Riemann problem. The geometry of the patch is well-defined when its centroid and length in the x-coordinate direction are provided. Note that the line segment patch DOES NOT allow for the smearing of its boundaries.

subroutine	s_spiral (patch_id, patch_id_fp, q_prim_vf)
	The spiral patch is a 2D geometry that may be used, The geometry of the patch is well-defined when its centroid and radius are provided. Note that the circular patch DOES allow for the smoothing of its boundary.

subroutine	s_circle (patch_id, patch_id_fp, q_prim_vf, ib)
	The circular patch is a 2D geometry that may be used, for example, in creating a bubble or a droplet. The geometry of the patch is well-defined when its centroid and radius are provided. Note that the circular patch DOES allow for the smoothing of its boundary.

subroutine	s_airfoil (patch_id, patch_id_fp, q_prim_vf, ib)

subroutine	s_3d_airfoil (patch_id, patch_id_fp, q_prim_vf, ib)

subroutine	s_varcircle (patch_id, patch_id_fp, q_prim_vf)
	The varcircle patch is a 2D geometry that may be used . It generatres an annulus.

subroutine	s_3dvarcircle (patch_id, patch_id_fp, q_prim_vf)

subroutine	s_ellipse (patch_id, patch_id_fp, q_prim_vf)
	The elliptical patch is a 2D geometry. The geometry of the patch is well-defined when its centroid and radii are provided. Note that the elliptical patch DOES allow for the smoothing of its boundary.

subroutine	s_ellipsoid (patch_id, patch_id_fp, q_prim_vf)
	The ellipsoidal patch is a 3D geometry. The geometry of the patch is well-defined when its centroid and radii are provided. Note that the ellipsoidal patch DOES allow for the smoothing of its boundary.

subroutine	s_rectangle (patch_id, patch_id_fp, q_prim_vf, ib)
	The rectangular patch is a 2D geometry that may be used, for example, in creating a solid boundary, or pre-/post- shock region, in alignment with the axes of the Cartesian coordinate system. The geometry of such a patch is well- defined when its centroid and lengths in the x- and y- coordinate directions are provided. Please note that the rectangular patch DOES NOT allow for the smoothing of its boundaries.

subroutine	s_sweep_line (patch_id, patch_id_fp, q_prim_vf)
	The swept line patch is a 2D geometry that may be used, for example, in creating a solid boundary, or pre-/post- shock region, at an angle with respect to the axes of the Cartesian coordinate system. The geometry of the patch is well-defined when its centroid and normal vector, aimed in the sweep direction, are provided. Note that the sweep line patch DOES allow the smoothing of its boundary.

subroutine	s_2d_taylorgreen_vortex (patch_id, patch_id_fp, q_prim_vf)
	The Taylor Green vortex is 2D decaying vortex that may be used, for example, to verify the effects of viscous attenuation. Geometry of the patch is well-defined when its centroid are provided.

subroutine	s_1d_analytical (patch_id, patch_id_fp, q_prim_vf)
	This patch assigns the primitive variables as analytical functions such that the code can be verified.

subroutine	s_1d_bubble_pulse (patch_id, patch_id_fp, q_prim_vf)

subroutine	s_2d_analytical (patch_id, patch_id_fp, q_prim_vf)
	This patch assigns the primitive variables as analytical functions such that the code can be verified.

subroutine	s_3d_analytical (patch_id, patch_id_fp, q_prim_vf)
	This patch assigns the primitive variables as analytical functions such that the code can be verified.

subroutine	s_spherical_harmonic (patch_id, patch_id_fp, q_prim_vf)
	This patch generates the shape of the spherical harmonics as a perturbation to a perfect sphere.

subroutine	s_sphere (patch_id, patch_id_fp, q_prim_vf, ib)
	The spherical patch is a 3D geometry that may be used, for example, in creating a bubble or a droplet. The patch geometry is well-defined when its centroid and radius are provided. Please note that the spherical patch DOES allow for the smoothing of its boundary.

subroutine	s_cuboid (patch_id, patch_id_fp, q_prim_vf, ib)
	The cuboidal patch is a 3D geometry that may be used, for example, in creating a solid boundary, or pre-/post-shock region, which is aligned with the axes of the Cartesian coordinate system. The geometry of such a patch is well- defined when its centroid and lengths in the x-, y- and z-coordinate directions are provided. Please notice that the cuboidal patch DOES NOT allow for the smearing of its boundaries.

subroutine	s_cylinder (patch_id, patch_id_fp, q_prim_vf, ib)
	The cylindrical patch is a 3D geometry that may be used, for example, in setting up a cylindrical solid boundary confinement, like a blood vessel. The geometry of this patch is well-defined when the centroid, the radius and the length along the cylinder's axis, parallel to the x-, y- or z-coordinate direction, are provided. Please note that the cylindrical patch DOES allow for the smoothing of its lateral boundary.

subroutine	s_sweep_plane (patch_id, patch_id_fp, q_prim_vf)
	The swept plane patch is a 3D geometry that may be used, for example, in creating a solid boundary, or pre-/post- shock region, at an angle with respect to the axes of the Cartesian coordinate system. The geometry of the patch is well-defined when its centroid and normal vector, aimed in the sweep direction, are provided. Note that the sweep plane patch DOES allow the smoothing of its boundary.

subroutine	s_model (patch_id, patch_id_fp, q_prim_vf, ib, stl_levelset, stl_levelset_norm)
	The STL patch is a 2/3D geometry that is imported from an STL file.

subroutine	s_convert_cylindrical_to_cartesian_coord (cyl_y, cyl_z)

function	f_convert_cyl_to_cart (cyl)

subroutine	s_convert_cylindrical_to_spherical_coord (cyl_x, cyl_y)

real(wp) function	f_r (myth, offset, a)
	Archimedes spiral function.

Function/Subroutine Documentation

◆ __m_patches_fpp_f90__()

program __m_patches_fpp_f90__

Here is the call graph for this function:

◆ f_convert_cyl_to_cart()

function __m_patches_fpp_f90__::f_convert_cyl_to_cart ( intent(in) cyl )

private

Here is the caller graph for this function:

◆ f_r()

real(wp) function __m_patches_fpp_f90__::f_r	(	real(wp), intent(in)	myth,
		real(wp), intent(in)	offset,
		real(wp), intent(in)	a )

private

Archimedes spiral function.

Parameters

myth	Angle
offset	Thickness
a	Starting position

Here is the call graph for this function:

Here is the caller graph for this function:

◆ s_1d_analytical()

subroutine __m_patches_fpp_f90__::s_1d_analytical	(	integer, intent(in)	patch_id,
		integer, dimension(0:m, 0:n, 0:p), intent(inout)	patch_id_fp,
		type(scalar_field), dimension(1:sys_size), intent(inout)	q_prim_vf )

private

This patch assigns the primitive variables as analytical functions such that the code can be verified.

Parameters

patch_id	is the patch identifier
patch_id_fp	Array to track patch ids
q_prim_vf	Array of primitive variables

Here is the call graph for this function:

Here is the caller graph for this function:

◆ s_1d_bubble_pulse()

subroutine __m_patches_fpp_f90__::s_1d_bubble_pulse	(	integer, intent(in)	patch_id,
		integer, dimension(0:m, 0:n, 0:p), intent(inout)	patch_id_fp,
		type(scalar_field), dimension(1:sys_size), intent(inout)	q_prim_vf )

private

Here is the caller graph for this function:

◆ s_2d_analytical()

subroutine __m_patches_fpp_f90__::s_2d_analytical	(	integer, intent(in)	patch_id,
		integer, dimension(0:m, 0:n, 0:p), intent(inout)	patch_id_fp,
		type(scalar_field), dimension(1:sys_size), intent(inout)	q_prim_vf )

private

This patch assigns the primitive variables as analytical functions such that the code can be verified.

Parameters

patch_id	is the patch identifier
patch_id_fp	Array to track patch ids
q_prim_vf	Array of primitive variables

Here is the call graph for this function:

Here is the caller graph for this function:

◆ s_2d_taylorgreen_vortex()

subroutine __m_patches_fpp_f90__::s_2d_taylorgreen_vortex	(	integer, intent(in)	patch_id,
		integer, dimension(0:m, 0:n, 0:p), intent(inout)	patch_id_fp,
		type(scalar_field), dimension(1:sys_size), intent(inout)	q_prim_vf )

private

The Taylor Green vortex is 2D decaying vortex that may be used, for example, to verify the effects of viscous attenuation. Geometry of the patch is well-defined when its centroid are provided.

Parameters

patch_id	is the patch identifier
patch_id_fp	Array to track patch ids
q_prim_vf	Array of primitive variables

Here is the caller graph for this function:

◆ s_3d_airfoil()

subroutine __m_patches_fpp_f90__::s_3d_airfoil	(	integer, intent(in)	patch_id,
		integer, dimension(0:m, 0:n, 0:p), intent(inout)	patch_id_fp,
		type(scalar_field), dimension(1:sys_size), intent(inout)	q_prim_vf,
		logical, intent(in), optional	ib )

private

Here is the caller graph for this function:

◆ s_3d_analytical()

subroutine __m_patches_fpp_f90__::s_3d_analytical	(	integer, intent(in)	patch_id,
		integer, dimension(0:m, 0:n, 0:p), intent(inout)	patch_id_fp,
		type(scalar_field), dimension(1:sys_size), intent(inout)	q_prim_vf )

private

This patch assigns the primitive variables as analytical functions such that the code can be verified.

Parameters

patch_id	is the patch identifier
patch_id_fp	Array to track patch ids
q_prim_vf	Array of primitive variables

Here is the call graph for this function:

Here is the caller graph for this function:

◆ s_3dvarcircle()

subroutine __m_patches_fpp_f90__::s_3dvarcircle	(	integer, intent(in)	patch_id,
		integer, dimension(0:m, 0:n, 0:p), intent(inout)	patch_id_fp,
		type(scalar_field), dimension(1:sys_size), intent(inout)	q_prim_vf )

private

Here is the caller graph for this function:

◆ s_airfoil()

subroutine __m_patches_fpp_f90__::s_airfoil	(	integer, intent(in)	patch_id,
		integer, dimension(0:m, 0:n, 0:p), intent(inout)	patch_id_fp,
		type(scalar_field), dimension(1:sys_size), intent(inout)	q_prim_vf,
		logical, intent(in), optional	ib )

private

Here is the caller graph for this function:

◆ s_circle()

subroutine __m_patches_fpp_f90__::s_circle	(	integer, intent(in)	patch_id,
		integer, dimension(0:m, 0:n, 0:p), intent(inout)	patch_id_fp,
		type(scalar_field), dimension(1:sys_size), intent(inout)	q_prim_vf,
		logical, intent(in), optional	ib )

private

The circular patch is a 2D geometry that may be used, for example, in creating a bubble or a droplet. The geometry of the patch is well-defined when its centroid and radius are provided. Note that the circular patch DOES allow for the smoothing of its boundary.

Parameters

patch_id	is the patch identifier
patch_id_fp	Array to track patch ids
q_prim_vf	Array of primitive variables
ib	True if this patch is an immersed boundary

Here is the caller graph for this function:

◆ s_convert_cylindrical_to_cartesian_coord()

subroutine __m_patches_fpp_f90__::s_convert_cylindrical_to_cartesian_coord	(	real(wp), intent(in)	cyl_y,
		real(wp), intent(in)	cyl_z )

private

Here is the caller graph for this function:

◆ s_convert_cylindrical_to_spherical_coord()

subroutine __m_patches_fpp_f90__::s_convert_cylindrical_to_spherical_coord	(	real(wp), intent(in)	cyl_x,
		real(wp), intent(in)	cyl_y )

private

◆ s_cuboid()

subroutine __m_patches_fpp_f90__::s_cuboid	(	integer, intent(in)	patch_id,
		integer, dimension(0:m, 0:n, 0:p), intent(inout)	patch_id_fp,
		type(scalar_field), dimension(1:sys_size), intent(inout)	q_prim_vf,
		logical, intent(in), optional	ib )

private

The cuboidal patch is a 3D geometry that may be used, for example, in creating a solid boundary, or pre-/post-shock region, which is aligned with the axes of the Cartesian coordinate system. The geometry of such a patch is well- defined when its centroid and lengths in the x-, y- and z-coordinate directions are provided. Please notice that the cuboidal patch DOES NOT allow for the smearing of its boundaries.

Parameters

patch_id	is the patch identifier
patch_id_fp	Array to track patch ids
q_prim_vf	Array of primitive variables

Here is the call graph for this function:

Here is the caller graph for this function:

◆ s_cylinder()

subroutine __m_patches_fpp_f90__::s_cylinder	(	integer, intent(in)	patch_id,
		integer, dimension(0:m, 0:n, 0:p), intent(inout)	patch_id_fp,
		type(scalar_field), dimension(1:sys_size), intent(inout)	q_prim_vf,
		logical, intent(in), optional	ib )

private

The cylindrical patch is a 3D geometry that may be used, for example, in setting up a cylindrical solid boundary confinement, like a blood vessel. The geometry of this patch is well-defined when the centroid, the radius and the length along the cylinder's axis, parallel to the x-, y- or z-coordinate direction, are provided. Please note that the cylindrical patch DOES allow for the smoothing of its lateral boundary.

Parameters

	patch_id	is the patch identifier
	patch_id_fp	Array to track patch ids
	q_prim_vf	Array of primitive variables
	ib	True if this patch is an immersed boundary
[in]	ib	True if this patch is an immersed boundary

Here is the call graph for this function:

Here is the caller graph for this function:

◆ s_ellipse()

subroutine __m_patches_fpp_f90__::s_ellipse	(	integer, intent(in)	patch_id,
		integer, dimension(0:m, 0:n, 0:p), intent(inout)	patch_id_fp,
		type(scalar_field), dimension(1:sys_size), intent(inout)	q_prim_vf )

private

The elliptical patch is a 2D geometry. The geometry of the patch is well-defined when its centroid and radii are provided. Note that the elliptical patch DOES allow for the smoothing of its boundary.

Parameters

patch_id	is the patch identifier
patch_id_fp	Array to track patch ids
q_prim_vf	Array of primitive variables

Here is the caller graph for this function:

◆ s_ellipsoid()

subroutine __m_patches_fpp_f90__::s_ellipsoid	(	integer, intent(in)	patch_id,
		integer, dimension(0:m, 0:n, 0:p), intent(inout)	patch_id_fp,
		type(scalar_field), dimension(1:sys_size), intent(inout)	q_prim_vf )

private

The ellipsoidal patch is a 3D geometry. The geometry of the patch is well-defined when its centroid and radii are provided. Note that the ellipsoidal patch DOES allow for the smoothing of its boundary.

Parameters

patch_id	is the patch identifier
patch_id_fp	Array to track patch ids
q_prim_vf	Array of primitive variables

Here is the call graph for this function:

Here is the caller graph for this function:

◆ s_line_segment()

subroutine __m_patches_fpp_f90__::s_line_segment	(	integer, intent(in)	patch_id,
		integer, dimension(0:m, 0:n, 0:p), intent(inout)	patch_id_fp,
		type(scalar_field), dimension(1:sys_size), intent(inout)	q_prim_vf )

The line segment patch is a 1D geometry that may be used, for example, in creating a Riemann problem. The geometry of the patch is well-defined when its centroid and length in the x-coordinate direction are provided. Note that the line segment patch DOES NOT allow for the smearing of its boundaries.

Parameters

patch_id	patch identifier
patch_id_fp	Array to track patch ids
q_prim_vf	Array of primitive variables

Here is the caller graph for this function:

◆ s_model()

subroutine __m_patches_fpp_f90__::s_model	(	integer, intent(in)	patch_id,
		integer, dimension(0:m, 0:n, 0:p), intent(inout)	patch_id_fp,
		type(scalar_field), dimension(1:sys_size), intent(inout)	q_prim_vf,
		logical, intent(in), optional	ib,
		type(levelset_field), intent(inout), optional	stl_levelset,
		type(levelset_norm_field), intent(inout), optional	stl_levelset_norm )

private

The STL patch is a 2/3D geometry that is imported from an STL file.

Parameters

	patch_id	is the patch identifier
	patch_id_fp	Array to track patch ids
	q_prim_vf	Primitive variables
	ib	True if this patch is an immersed boundary
	STL_levelset	STL levelset
	STL_levelset_norm	STL levelset normals
[in,out]	stl_levelset	Levelset determined by models
[in,out]	stl_levelset_norm	Levelset_norm determined by models
[in]	ib	True if this patch is an immersed boundary

Here is the call graph for this function:

Here is the caller graph for this function:

◆ s_rectangle()

subroutine __m_patches_fpp_f90__::s_rectangle	(	integer, intent(in)	patch_id,
		integer, dimension(0:m, 0:n, 0:p), intent(inout)	patch_id_fp,
		type(scalar_field), dimension(1:sys_size), intent(inout)	q_prim_vf,
		logical, intent(in), optional	ib )

private

The rectangular patch is a 2D geometry that may be used, for example, in creating a solid boundary, or pre-/post- shock region, in alignment with the axes of the Cartesian coordinate system. The geometry of such a patch is well- defined when its centroid and lengths in the x- and y- coordinate directions are provided. Please note that the rectangular patch DOES NOT allow for the smoothing of its boundaries.

Parameters

	patch_id	is the patch identifier
	patch_id_fp	Array to track patch ids
	q_prim_vf	Array of primitive variables
	ib	True if this patch is an immersed boundary
[in]	ib	True if this patch is an immersed boundary

Here is the caller graph for this function:

◆ s_sphere()

subroutine __m_patches_fpp_f90__::s_sphere	(	integer, intent(in)	patch_id,
		integer, dimension(0:m, 0:n, 0:p), intent(inout)	patch_id_fp,
		type(scalar_field), dimension(1:sys_size), intent(inout)	q_prim_vf,
		logical, intent(in), optional	ib )

private

The spherical patch is a 3D geometry that may be used, for example, in creating a bubble or a droplet. The patch geometry is well-defined when its centroid and radius are provided. Please note that the spherical patch DOES allow for the smoothing of its boundary.

Parameters

	patch_id	is the patch identifier
	patch_id_fp	Array to track patch ids
	q_prim_vf	Array of primitive variables
	ib	True if this patch is an immersed boundary
[in]	ib	True if this patch is an immersed boundary

Here is the call graph for this function:

Here is the caller graph for this function:

◆ s_spherical_harmonic()

subroutine __m_patches_fpp_f90__::s_spherical_harmonic	(	integer, intent(in)	patch_id,
		integer, dimension(0:m, 0:n, 0:p), intent(inout)	patch_id_fp,
		type(scalar_field), dimension(1:sys_size), intent(inout)	q_prim_vf )

private

This patch generates the shape of the spherical harmonics as a perturbation to a perfect sphere.

Parameters

patch_id	is the patch identifier
patch_id_fp	Array to track patch ids
q_prim_vf	Array of primitive variables

Here is the call graph for this function:

Here is the caller graph for this function:

◆ s_spiral()

subroutine __m_patches_fpp_f90__::s_spiral	(	integer, intent(in)	patch_id,
		integer, dimension(0:m, 0:n, 0:p), intent(inout)	patch_id_fp,
		type(scalar_field), dimension(1:sys_size), intent(inout)	q_prim_vf )

private

The spiral patch is a 2D geometry that may be used, The geometry of the patch is well-defined when its centroid and radius are provided. Note that the circular patch DOES allow for the smoothing of its boundary.

Parameters

patch_id	patch identifier
patch_id_fp	Array to track patch ids
q_prim_vf	Array of primitive variables

Here is the call graph for this function:

Here is the caller graph for this function:

◆ s_sweep_line()

subroutine __m_patches_fpp_f90__::s_sweep_line	(	integer, intent(in)	patch_id,
		integer, dimension(0:m, 0:n, 0:p), intent(inout)	patch_id_fp,
		type(scalar_field), dimension(1:sys_size), intent(inout)	q_prim_vf )

private

The swept line patch is a 2D geometry that may be used, for example, in creating a solid boundary, or pre-/post- shock region, at an angle with respect to the axes of the Cartesian coordinate system. The geometry of the patch is well-defined when its centroid and normal vector, aimed in the sweep direction, are provided. Note that the sweep line patch DOES allow the smoothing of its boundary.

Parameters

patch_id	is the patch identifier
patch_id_fp	Array to track patch ids
q_prim_vf	Array of primitive variables

Here is the caller graph for this function:

◆ s_sweep_plane()

subroutine __m_patches_fpp_f90__::s_sweep_plane	(	integer, intent(in)	patch_id,
		integer, dimension(0:m, 0:n, 0:p), intent(inout)	patch_id_fp,
		type(scalar_field), dimension(1:sys_size), intent(inout)	q_prim_vf )

private

The swept plane patch is a 3D geometry that may be used, for example, in creating a solid boundary, or pre-/post- shock region, at an angle with respect to the axes of the Cartesian coordinate system. The geometry of the patch is well-defined when its centroid and normal vector, aimed in the sweep direction, are provided. Note that the sweep plane patch DOES allow the smoothing of its boundary.

Parameters

patch_id	is the patch identifier
patch_id_fp	Array to track patch ids
q_prim_vf	Primitive variables

Here is the call graph for this function:

Here is the caller graph for this function:

◆ s_varcircle()

subroutine __m_patches_fpp_f90__::s_varcircle	(	integer, intent(in)	patch_id,
		integer, dimension(0:m, 0:n, 0:p), intent(inout)	patch_id_fp,
		type(scalar_field), dimension(1:sys_size), intent(inout)	q_prim_vf )

private

The varcircle patch is a 2D geometry that may be used . It generatres an annulus.

Parameters

patch_id	is the patch identifier
patch_id_fp	Array to track patch ids
q_prim_vf	Array of primitive variables

Here is the caller graph for this function:

Functions/Subroutines

Function/Subroutine Documentation

◆ __m_patches_fpp_f90__()

◆ f_convert_cyl_to_cart()

◆ f_r()

◆ s_1d_analytical()

◆ s_1d_bubble_pulse()

◆ s_2d_analytical()

◆ s_2d_taylorgreen_vortex()

◆ s_3d_airfoil()

◆ s_3d_analytical()

◆ s_3dvarcircle()

◆ s_airfoil()

◆ s_circle()

◆ s_convert_cylindrical_to_cartesian_coord()

◆ s_convert_cylindrical_to_spherical_coord()

◆ s_cuboid()

◆ s_cylinder()

◆ s_ellipse()

◆ s_ellipsoid()

◆ s_line_segment()

◆ s_model()

◆ s_rectangle()

◆ s_sphere()

◆ s_spherical_harmonic()

◆ s_spiral()

◆ s_sweep_line()

◆ s_sweep_plane()

◆ s_varcircle()