CMR Header

CCMC Metadata Registry (CMR)

Menu Page

Go to:

CMR: View Simulation Run Info

OSPREI/1/ROR/TEMPLATE

Run Description

SimulationRun Metadata Template for OSPREI version 1 ROR runs

Simulation Time:

Simulation Start Time:
Simulation End Time:
Time Step in second:
Simulation Time Description:
Simulation Time Caveats:

Temporal Dependence (whether the outputs of the simulation code are time-dependent?): true

Regions:

Heliosphere.Inner
Sun

Simulation Domain :

Contacts :

List of Run Input Parameter Grouping and their associated properties :

Name

Description

Caveats

Properties

Basic Info

Name	Label	Description	Valid Min	Valid Max
date	date	date
time	time	time
models	models	Models to run: Set which components to run. OSPREI takes 'ALL', 'noB' (ForeCAT and ANTEATR), 'IP' (ANTEATR and FIDO), 'FC' (ForeCAT only), 'ANT' (ANTEATR only), and 'FIDO' (FIDO only).
suffix	suffix	Suffix to identify this specific run: A string tag to add to the model result file names.
MagFile	MagFile	Name of the magnetogram file
Show Hidden	Show Hidden	Show Hidden
Start	Start	The start time of the simulation.
nRuns	nRuns	Number of runs to perform. If greater than 1 it will perform an ensemble.	1	200

Target Source

Name	Label	Description	Caveats	Units	Default Value or Actual Value	Valid Min	Valid Max
satellite	satellite	Set the satellite for which OSPREI simulates arrival time and in situ profiles. Can pick from Earth, STEREO A, STEREO B, PSP, and SolO.	enum: Earth, STA, STB, PSP, SolO

PFSS Info

Name	Label	Description	Caveats	Units	Default Value or Actual Value	Valid Min	Valid Max
Magnetogram	Magnetogram	Magnetogram source: Observatory to use for the magnetogram that generates the background PFSS magnetic field. Not required if ForeCAT is not run.	enum: HMI, GONG, WSA
PFSSscale	PFSSscale	Option to scale the PFSS magnetic field: Allows for scaling of the PFSS magnetic field by a constant factor. This is mostly useful for balancing some of the differences between magnetograms from different observatories.	The model do allow scaling to high values, which can be useful for extrasolar cases, but we caution that the model isn't thoroughly tested and definitely less stable with extreme magnetic backgrounds			> 0.1
sunRss	sunRss	sunRss		Rs	2.5	1.5	5
nCoeffs	nCoeffs	nCoeffs			90	30	120

CME Properties

Name	Label	Description	Caveats	Units	Default Value or Actual Value	Valid Min	Valid Max
CMEr	CMEr	Radial distance of the CME at the start of the simulation	The defaults and allowed ranges vary with starting model: ForeCAT: default 1.1 Rs, range: 1.05-2.5 Rs ANTEATR: default 21.5 Rs, range: 10-50 Rs FIDO: defaults to initial satellite radius, range: 1.05-1100 Rs	Rs
CMElat	CMElat	CME latitude: Starting latitude of the CME in degrees relative to solar equator		deg		-90	90
CMElon	CMElon	CME longitude: Starting longitude of the CME in degrees. Expressed in Carrington coordinates if ForeCAT is used but otherwise in Stonyhurst (relative to the Earth).		deg		0	360
CMEtilt	CMEtilt	CME tilt: The tilt of the CME, measured in degrees counterclockwise from solar west (right limb of Sun)		deg		-90	90
CMEvr	CMEvr	CME velocity: Speed of the CME in the outer corona, unless FIDO-only when it is the speed at the time of contact		km/s		> 0
CMEAWp	CMEAWp	Perpendicular or edge-on angular width of the CME	default value: {CMEAW}/3	deg		5	90
CMEM	CMEM	CME mass in the outer corona.	default value: 0.010*{CMEvr}+0.16	10^15 g		0.1
CMEdelAx	CMEdelAx	Aspect ratio of the toroidal axis of the CME (radial length divided by perpendicular length).			0.75	0.1	1.5
CMEdelCS	CMEdelCS	Aspect ratio of the cross section of the CME (radial length divided by perpendicular length).			1	0.1	1.5
CMEAW	CMEAW	Face on half angular width of the CME in degrees. For everything but the FIDO-only cases this is the AW in the outer corona. For the FIDO-only cases this is the AW upon arrival at the spacecraft. The GCS half angle α is technically the separation of the legs. We suggest calculating the OSPREI AW as arctan((sinα + k * sqrt(1-k^2 + sin^2 α)) / (1 - k^2)), where k is the GCS shape ratio.		deg		5	180

ForeCAT Settings

Name	Label	Description	Caveats	Units	Default Value or Actual Value	Valid Min	Valid Max
FCrmax	FCrmax	Transition between ForeCAT and ANTEATR: The distance (in Rs) at which OSPREI stops the ForeCAT simulation and starts the ANTEATR simulation.	Defaults to 21.5 Rs (0.1 AU), Allowed range of [10,50], Strongly recommanded to use 21.5 Rs. Running ForeCAT beyond ~10 Rs isn't really necessary, the coronal forces are typically negigible, ANTEATR can easily become unstable if started too close with unbalanced parameters (FRB, FRT too high typically) so even 10-21.5 Rs can be questionable, Matches transition from coronal to interplanetary at 0.1 AU, which is common in much of the field	Rs	21.5	10	21.5
FCraccel1	FCraccel1	First critical distance in ForeCAT propagation model: Radial distance (in Rs) at which ForeCAT transitions from the initial slow rise at FCvrmin to rapid acceleration; can potentially estimate from EUV imagery.	Start time should be the first signs of movement , Expect that rapid acceleration begins when rapid rise in flare energy occurs (or just more obvious movement in EUV), measure CME height at that time. Defaults to 1.3 Rs, Range of [1.0,2.0] If starting R is less than FCraccel1 then the CME will start with vr > vrmin since the acceleration has already begun	Rs	1.3	1	2
FCraccel2	FCraccel2	Second critical distance in ForeCAT propagation model: Radial distance (in Rs) at which ForeCAT transitions from the rapid acceleration to constant propagation speed in the corona, This is meant to represent a CME getting up to 'full speed', not any prolonged effects of a drag interaction with the background SW (that is simulated by ANTEATR), Can fine tune based on when ~constant speed is observed in the corona.	Use known start time and adjust FRraccel2 so that ForeCAT CME arrives at the right distance at the right time. Defaults to 10 Rs, somewhat arbitrary but reasonable; Allowed range [1.5, 21.5] Checks that FCraccel2 is < FCrmax so that max v is actually reached within ForeCAT, Streamer blowouts tend to have the farthest distance due to slow gradual acceleration	Rs	10	1.5	21.5
FCvrmin	FCvrmin	Minimum velocity in ForeCAT propagation model: Minimum velocity (in km/s) in the first phase of the three phase propagation model used in ForeCAT	Assuming starting distance is < FCraccel1 then it is the initial velocity of the CME, Hard to measure precisely, can try and estimate, Start time of simulation based on first movement in EUV, Measure time of flare start (where energy starts to peak) and CME height at that time, Modify vmin so that simulated CME reaches right height at right time	km/s	50	10	200
FCAWmin	FCAWmin	Minimum angular width in ForeCAT expansion model: Parameter (in deg) that sets the value of the ForeCAT expansion model at R = 1	Not a physical property as much as a numerical constraint: AW(R) = AWmin + (AWmax-AWmin) * {1 - exp(-(R-1)/AWr)}, Rapidly begins expanding as R increases above 1, Hold constant once reaches given AW, Defaults to 5, somewhat arbitrary but reasonable, Allowed range of [1,20]	deg	5	1	20
FCAWr	FCAWr	Rate of expansion in ForeCAT expansion model: Length scale (in Rs) that controls how rapidly the CME expands in ForeCAT	AW(R) = AWmin + (AWmax-AWmin) * {1 - exp(-(R-1)/AWr)}, Hold constant once reaches given AW, Higher AWr means slower expansion, Defaults to 1 Rs, somewhat arbitrary but reasonable, Allowed range of [0.1, (FCrmax-1)/4.61], Upper limit set so that AW(FCrmax) is no less than 99% of given AW by end of ForeCAT domain	Rs	1	0.1
FCrmaxM	FCrmaxM	Distance of maximum mass in ForeCAT: CME mass increases linearly within ForeCAT until it reaches FCrmaxM (in Rs)	Simulation starts with mass at half of the given mass, Defaults to end of ForeCAT simulation (FCrmax), Range of [CMEr, FCrmax]	Rs
SWCdp	SWCdp	Solar wind perpendicular drag coefficient: Drag coefficient for the drag force slowing any nonradial motion/deflection in the corona	Only used in ForeCAT, Same form as radial drag used in ANTEATR, Force proportional to Cdp * (vCME-vSW) \|vCME-vSW\|, Assumed to be “near unity” so defaults to 1		1	0	10

Flux Rope Properties

Name	Label	Description	Caveats	Units	Default Value or Actual Value	Valid Min	Valid Max
FRpol	FRpol	Polarity/handedness of the Flux Rope	Whether the flux rope is either left- or right-handed. Only required by cases that make use of FIDO. ANTEATR does not care about the polarity of the magnetic field, only the strength, OSPREI accepts values of either 1 (right) or -1 (left). Defaults to the Bothmer-Schwenn relation based on the initial latitude of the CME (-1 in the North and 1 in the South). This is better than a complete guess but it is better to use any EUV signatures to identify the handedness.		+1
FRB	FRB	Magnetic field strength of the CME Flux Rope: The magnetic field strength in nT, measured at the central axis of the CME when in the corona.	This is needed for ANTEATR forces and FIDO in situ profiles. This is almost impossible to directly measure in a real time scenario. The sign of FRB determines the direction of the magnetic along the central axis.	nT		500	10000
FRT	FRT	Temperature of the CME Flux Rope: Internal temperature of the CME in K at the start of ANTEATR.	If only FIDO is run then the value is at the time of spacecraft contact. We have a default method of scaling the temperature based off of the coronal speed based on correlations found in the literature.	K		5000	1000000
FRtau	FRtau	Flux rope tau: Parameter controlling the amount of twist in the Eliptic-Cylindrical flux rope.	Not all combinations of tau and Cnm are stable and can cause the forces in ANTEATR to become unstable		1	0.1	3
FRCnm	FRCnm	Flux rope Cnm: Parameter controlling the relative amount of toroidal and poloidal flux in the Eliptic-Cylindrical flux rope.	Not all combinations of tau and Cnm are stable and can cause the forces in ANTEATR to become unstable		1.927	0.5	3

ANTEATR Settings

Name	Label	Description	Caveats	Default Value or Actual Value	Valid Min	Valid Max
IVDf	IVDf	Initial velocity decomposition for ANTEATR: Parameter controlling how the propagation speed of the CME is broken down into bulk motion and expansion speeds within ANTEATR.	Can chose between self-similar (0), convective (1), or any value between.	0.5	0	1
Gamma	Gamma	Adiabatic index: The adiabatic index within the flux rope	Controls how the CME's expansion affects the internal temperature. Default to 4/3, range of [1, 5/3] or Halfway between extremes of isothermal (1) and adiabatic, ideal gas (5/3).	1.33	1	1.67
doPUP	doPUP	Simulate CME-driven sheath: Include the simulation of a CME-driven sheath within the ANTEATR simulation. The CME starts with no sheath at the beginning of the ANTEATR portion and gradually accumulates it.	Only options are 'True' or 'False', default to False.	false
flagScales	flagScales	Flag to switch to scaling CME B/T: Option to give FRB (Magnetic field strength of the CME flux rope) and FRT (Temperature of the CME Flux Rope) relative to the solar background as opposed to using physical units.	Only options are 'True' or 'False'; default to False.	false

Solar Wind Properties

Name	Label	Description	Caveats	Units	Default Value or Actual Value	Valid Min	Valid Max
SWR	SWR	Distance at which SW parameters are given: Radial distance of the given SW parameters. If this distance is not specified then all the values are assumed to be at the radial distance of the satellite.	Useful if you only know 1 AU properties but want to simulate the impact at different location.	Rs		10	350
SWn	SWn	Solar wind number density: Number density of the solar wind (in cm^-3) at the satellite location.	Default assumes near-Earth and uses an average slow solar wind value of 7.5 cm^-3 (midpoint of range in Owens 2020 article 'Solar-Wind Structure')	cm^-3	7.5	0.1	5
SWv	SWv	Solar wind radial velocity: Radial velocity of the solar wind (in km/s) at the satellite location.	Default assumes near-Earth and uses an average slow solar wind value of 350 km/s (midpoint of range in Owens 2020 article 'Solar-Wind Structure')	km/s	350	50	800
SWB	SWB	Solar wind magnetic field strength: The total magnetic field strength of the solar wind (in nT) at the satellite location.	The sign of SWB can be used to indicate whether the radial field is pointed inward (-) or outward (+). This is only used for the in situ magnetic field in FIDO and should be the value immediately upstream of the CME. Default assumes near-Earth and uses an average slow solar wind value of 6 nT (midpoint of range in Owens 2020 article 'Solar-Wind Structure'). Default also points outward	nT	6	-50	50
SWT	SWT	Solar wind temperature: Temperature of the solar wind (in K) at the satellite location.	Default assumes near-Earth and uses an average slow solar wind value of 75000 K (midpoint of range in Owens 2020 article 'Solar-Wind Structure')	K	75000	10000	5000000
SWCd	SWCd	Solar wind drag coefficient: Drag coefficient between a CME and the Sun in the radial direction.	Only used in ANTEATR, to determine the deceleration (or occasional acceleration) of a CME.		1	1	10

MEOW-HiSS Properties

Name	Label	Description	Caveats	Units	Default Value or Actual Value	Valid Min	Valid Max
doMH	doMH	Simulate a high speed stream in the background solar wind	Include the MEOW-HiSS model in ANTEATR, which add a time-dependent empirical HSS, If included then MHarea and MHdist must be specified, Only options are 'True' or 'False', Defaults to False.		false
MHarea	MHarea	MEOW-HiSS CH area: Area of the coronal hole (in 10^8 km^2) that is the source region of the background high speed stream.	This modifies the background solar wind profile, but is not included in the default settings. The CH area can be estimated using JHelioviewer. MEOW-HiSS was developed based on MHD simulations with CH areas between 50x10^8 and 2500x10^8 km^2 so we restrict to that range.	10^8 km^2		50	2500
MHdist	MHdist	MEOW-HiSS HSS front distance: The distance (in AU) of the front of the high speed stream at the start of the simulation..	This distance can come from some other model of the HSS (e.g. ENLIL). Numerically it will allow negative distances to indicate that the CH has not yet rotated onto disk center at the start of the simulation. If one knows the time for the CH to reach disk center this can be converted to a negative distance using the propagation velocity of the HSS.	AU		-0.3	1.5

Observed Boundaries

Name	Label	Description	Caveats	Units
ObsDataFile	ObsDataFile	File containing the observations [ObsDataFile, 0x2xx5]
obsShstart	obsShstart	Observed start of the sheath: Date and time (in DoY with time as decimal) of the start of the CME driven-sheath	Used to calculate metrics related to FIDO results	DoY
obsFRstart	obsFRstart	Observed start of the CME: Date and time (in DoY with time as decimal) of the start of the flux rope or magnetic obstacle portion of the CME.	Must be after obsShstart	DoY
obsFRend	obsFRend	Observed end of the CME: Date and time (in DoY with time as decimal) of the end of the flux rope or magnetic obstacle portion of the CME.	Must be after obsFRstart	DoY

Others

Name	Label	Description	Caveats	Units	Default Value or Actual Value
isSat	isSat	Flag to switch output B vector coordinates	OSPREI's default setting is to output the B vector in GSE coordinates, setting this flag to 'true' would switches it to satellite coordinates.		false
satPath	satPath	Option to use an input satellite trajectory	ANTEATR and FIDO need to know the satellite location to determine time of impact and in situ properties. OSPREI can either use a given lat/lon/distance at the start time and includes the option for an orbital rate OR a file with the satellite trajectory as a function of time can be directly provided. The path option is selected by giving the name of the file to satPath. The satPath file should contain the date ('YYYY-MM-DD HH:MM:SS' format), the radial distance (AU), the latitude (deg from solar equator), and the longitude (deg).
FCmagname	FCmagname	Input background magnetic field file
FCtprint	FCtprint	Time resolution of the ForeCAT output e.g. 10 minutes		minute	10
FCRotCME	FCRotCME	Include CME rotation in ForeCAT (e.g. true or false)			true
FCNtor	FCNtor	Number of points in the toroidal direction in the grid used to represent a CME within ForeCAT.			15
FCNpol	FCNpol	Number of points in the poloidal direction in the grid used to represent a CME within ForeCAT			13
L0	L0	Option to uniformly shift the longitude of the ForeCAT results. If set equal to the initial satellite longitude in Carrington coordinates then the CME motion will be given relative to the satellite location.			0
SunR	SunR	Radius of the star in cm. Allows for simulating non-solar cases.			7e10
SunRotRate	SunRotRate	Rotation rate of the star in rad/s. Allows for simulating non-solar cases.			2.8e-6
saveData	saveData	Whether or not to save the results for each run into individual text files.	True for single run, False for ensemble.
printData	printData	Whether or not to print the results to the command line.			false
useFCSW	useFCSW	Use ForeCAT solar wind as opposed to provide model. ForeCAT has coronal plasma properties, which can be extend to fill interplanetary space but it's better to have a discontinuity and switch to IP parameters at ANTEATR.			false
includeSIT	includeSIT	Include SIT component of FIDO, which estimates a sheath using only the information at the time of impact. The sheath component of ANTEATR is much more reliable. Accordingly, the current version of OSPREI with ANTEATR/FIDO integrated to run simultaneously has not SIT set up as an option.			false
SWfile	SWfile	Option to include a 1D profile for the background solar wind, rather than using the empirical ambient model (and/or MEOW-HiSS). File should have R [AU], n [cm^-3], vr [km/s], Br [nT], Blon [nT], and T [K]			None

Ensemble options

Name	Label	Description	Units	Default Value or Actual Value	Valid Max
delta_CMElat	delta_CMElat	delta_CMElat	deg	1	30
delta_CMElon	delta_CMElon	delta_CMElon	deg	1	50
delta_CMEtilt	delta_CMEtilt	delta_CMEtilt	deg	5	60
delta_CMEyaw	delta_CMEyaw	delta_CMEyaw	deg	1	20
delta_CMEvr	delta_CMEvr	delta_CMEvr	km/s	50	1000
delta_CMEAW	delta_CMEAW	delta_CMEAW	deg	5	30
delta_CMEAWp	delta_CMEAWp	delta_CMEAWp	deg	2	20
delta_CMEdelAx	delta_CMEdelAx	delta_CMEdelAx		0.1	0.5
delta_CMEdelCS	delta_CMEdelCS	delta_CMEdelCS		0.1	0.5
delta_CMEM	delta_CMEM	delta_CMEM	10^15 g	2	50
delta_FCraccel1	delta_FCraccel1	delta_FCraccel1	Rsun	0.1	0.5
delta_FCraccel2	delta_FCraccel2	delta_FCraccel2	Rsun	0.5	5
delta_FCvrmin	delta_FCvrmin	delta_FCvrmin	km/s	20	50
delta_FCAWmin	delta_FCAWmin	delta_FCAWmin	deg	2	5
delta_FCAWr	delta_FCAWr	delta_FCAWr	Rsun	0.2	1
delta_FCrmaxM	delta_FCrmaxM	delta_FCrmaxM	Rsun	0.5	5
delta_FRB	delta_FRB	delta_FRB	nT	500	5000
delta_FRtau	delta_FRtau	delta_FRtau		0.2	1
delta_FRCnm	delta_FRCnm	delta_FRCnm		0.2	2
delta_FRT	delta_FRT	delta_FRT	K	50000	5000000
delta_IVDf	delta_IVDf	delta_IVDf		0.1	0.5
delta_Gamma	delta_Gamma	delta_Gamma		0.1	0.5
delta_SWCd	delta_SWCd	delta_SWCd		0.25	5
delta_SWCdp	delta_SWCdp	delta_SWCdp		0.25	5
delta_SWn	delta_SWn	delta_SWn	cm^-3	3	10
delta_SWv	delta_SWv	delta_SWv	km/s	25	300
delta_SWB	delta_SWB	delta_SWB	nT	3	20
delta_SWT	delta_SWT	delta_SWT	K	10000	50000
delta_MHarea	delta_MHarea	delta_MHarea	10^8 km^2	500	1000
delta_MHdist	delta_MHdist	delta_MHdist	AU	0.2	0.5

Run Access Information :

Keyword(s) :

Linked to Parent Spase Resource(s) (example: SimulationModel) :

spase://CCMC/SimulationModel/OSPREI/1

List of Publications Referencing this Run :

CMR Footer

Curator: Chiu Wiegand | NASA Official: Dr. Masha Kuznetsova | Privacy and Security Notices | Accessibility | CCMC Data Collection Consent Agreement